p4api.net

The StrDictListIterator represents the iterator functions exposed by the P4 bridge dll to allow the client to read structured (tagged) data. It is not exposed outside the p4.net assembly as the P4Server class translates the raw data into a .NET array list of hash tables.

Simple calls used to read key:value pairs from a StrDict object referenced by a pointer returned from the bridge

Error severity levels.

Unknown

nothing yet

something good happened

something not good happened

user did something wrong

system broken -- nothing can continue

Used to turnoff exceptions

Class used to return a single error or warning from the bridge dll.

How severe is the error

Generic code for the error

Descriptive error message

Create a new ClientError

Format the error in the form [ErrorLevel] Message

Class used to return a list of errors and warnings returned by a command.

Read an error list from the server by traversing the linked list.

Perforce server First error in the list

Create a list of a single error

Error

Create a list of a single error

Error message Severity level

Read the error list from the server

Create a list from the current error results on the server

Perforce Server

Cast the errors to a String[]

the list to cast

Cast the errors to a String. Each error is separated by \r\n

the list to cast

Used to wrap a byte[] that is pinned in memory to pass down to the dll. In general, since .NET does not natively support marshaling Strings to UTF-8 for char * parameters, we must do our own encoding of the strings into byte[], pin them, pass them to the dll, and then free the pinned memory on return. This class wraps that process with an IDisposable object to ensure the memory is freed after the call.

Class containing the DLL imports for the P4Bridge DLL.

Wrapper for an array of PinnedByteArrays, used to wrap the arg list passed to a command to make sure the pinned memory is freed.

Represents a Perforce server and connection.

Create a new branch in the repository.

Branch specification for the new branch The Branch object if new branch was created, null if creation failed

Update the record for a branch in the repository

Branch specification for the branch being updated The Branch object if new depot was saved, null if creation failed

Get the record for an existing branch from the repository.

Branch name Flags used when fetching an existing branch The Branch object if branch was found, null if creation failed

Get a list of branches from the repository

A list containing the matching branches
p4 help branches

branches -- Display list of branch specifications

p4 branches [-t] [-u user] [[-e|-E] nameFilter -m max]

Lists branch specifications. (See 'p4 help branch'.)

The -t flag displays the time as well as the date.

The -u user flag lists branch specs owned by the specified user.

The -e nameFilter flag lists branch specs with a name that matches
the nameFilter pattern, for example: -e 'svr-dev-rel*'. -E makes
the matching case-insensitive.

The -m max flag limits output to the specified number of branch specs.

Delete a branch from the repository

The branch to be deleted The 'f' and '-d' flags are valid when deleting an existing branch

Create a new job in the repository.

Job specification for the new job The '-i' flags is needed when creating a new job The Job object if new job was created, null if creation failed The '-i' flags is added if not specified by the caller

p4 help job

job -- Create or edit a job (defect) specification

p4 job [-f] [jobName]
p4 job -d jobName
p4 job -o [jobName]
p4 job -i [-f]

The 'p4 job' command creates and edits job specifications using an
ASCII form. A job is a defect, enhancement, or other unit of
intended work.The 'p4 fix' command associates changelists with jobs.

With no arguments, 'p4 job' creates an empty job specification
and invokes the user's editor. When the specification is saved,
a job name of the form jobNNNNNN is assigned. If the jobName
parameter is specified on the command line, the job is created or
opened for editing.

As jobs are entered or updated, all fields are indexed for searching
Text fields are broken into individual alphanumeric words (punctuation
and whitespace are ignored) and each word is case-folded and entered
into the word index. Date fields are converted to an internal
representation (seconds since 1970/01/01 00:00:00) and entered
into the date index.

The fields that compose a job are defined by the 'p4 jobspec' command.
Perforce provides a default job specification that you can edit.

The -d flag deletes the specified job. You cannot delete a job if
it has pending or submitted fixes associated with it.

The -o flag writes the job specification to the standard output.
The user's editor is not invoked.

The -i flag reads a job specification from the standard input. The
user's editor is not invoked.

The -f flag enables you set fields that are read-only by default.
The -f flag requires 'admin' access, which is granted using the
'p4 protect' command.

Create a new job in the repository.

Job specification for the new job The Job object if new job was created, null if creation failed

Update the record for a job in the repository

Job specification for the job being updated The Job object if new job was saved, null if creation failed

Get the record for an existing job from the repository.

Job name There are no valid flags to use when fetching an existing job The Job object if new job was found, null if creation failed

Get a list of jobs from the repository

options for the jobs command A list containing the matching jobs
p4 help jobs

jobs -- Display list of jobs

p4 jobs [-e jobview -i -l -m max -r] [file[revRange] ...]
p4 jobs -R

Lists jobs in the server. If a file specification is included, fixes
for submitted changelists affecting the specified files are listed.
The file specification can include wildcards and a revision range.
See 'p4 help revisions' for details about specifying revisions.

The -e flag lists jobs matching the expression specified in the
jobview parameter. For a description of jobview syntax, see 'p4 help
jobview'.

The -i flag includes any fixes made by changelists integrated into
the specified files.

The -l flag produces long output with the full text of the job
descriptions.

The -m max flag limits the output to the first 'max' jobs, ordered
by their job name.

The -r flag sorts the jobs in reverse order (by job name).

The -R flag rebuilds the jobs table and reindexes each job, which
is necessary after upgrading to 98.2. 'p4 jobs -R' requires that
that the user be an operator or have 'super' access granted by
'p4 protect'.

Delete a job from the repository

The job to be deleted Only the '-f' flag is valid when deleting an existing job

Create a new depot in the repository.

Depot specification for the new depot The '-i' flag is required when creating a new depot The Depot object if new depot was created, null if creation failed The '-i' flag is added if not specified by the caller

p4 help depot

depot -- Create or edit a depot specification

p4 depot name
p4 depot -d name
p4 depot -o name
p4 depot -i

Create a new depot specification or edit an existing depot
specification. The specification form is put into a temporary file
and the editor (configured by the environment variable $P4EDITOR)
is invoked.

The depot specification contains the following fields:

Depot: The name of the depot. This name cannot be the same as
any branch, client, or label name.

Owner: The user who created this depot.

Date: The date that this specification was last modified.

Description: A short description of the depot (optional).

Type: 'local', 'stream', 'remote', 'spec', or 'archive'.

A 'local' depot (the default) is managed directly by
the server and its files reside in the server's root
directory.

A 'stream' depot is a local depot dedicated to the
storage of files in a stream.

A 'remote' depot refers to files in another Perforce
server.

A 'spec' depot automatically archives all edited forms
(branch, change, client, depot, group, job, jobspec,
protect, triggers, typemap, and user) in special,
read-only files. The files are named:
//depotname/formtype/name[suffix]. Updates to jobs made
by the 'p4 change', 'p4 fix', and 'p4 submit' commands
are also saved, but other automatic updates such as
as access times or opened files (for changes) are not.
A server can contain only one 'spec' depot.

A 'archive' depot defines a storage location to which
obsolete revisions may be relocated.

Address: For remote depots, the $P4PORT (connection address)
of the remote server.

Suffix: For spec depots, the optional suffix to be used
for generated paths. The default is '.p4s'.

Map: Path translation information, in the form of a file
pattern with a single ... in it. For local depots,
this path is relative to the server's root directory
(Example: depot/...). For remote depots, this path
refers to the remote server's namespace
(Example: //depot/...).

The -d flag deletes the specified depot. If any files reside in the
depot, they must be removed with 'p4 obliterate' before deleting the
depot.

The -o flag writes the depot specification to standard output. The
user's editor is not invoked.

The -i flag reads a depot specification from standard input. The
user's editor is not invoked.

Create a new depot in the repository.

Depot specification for the new depot The Depot object if new depot was created, null if creation failed

Update the record for a depot in the repository

Depot specification for the depot being updated The Depot object if new depot was saved, null if creation failed

Get the record for an existing depot from the repository.

Depot name There are no valid flags to use when fetching an existing depot The Depot object if depot was found, null if creation failed

Get a list of depots from the repository

A list containing the matching depots
p4 help depots

depots -- Lists defined depots

p4 depots

Lists all depots defined in the server.
Depots takes no arguments.

Delete a depot from the repository

The depot to be deleted Only the '-d' flag is valid when deleting an existing depot

Create a new group in the repository.

Group specification for the new group The '-i' flags are required when creating a new group The Group object if new group was created, null if creation failed The '-i' flag is added if not specified by the caller

p4 help group

group -- Change members of user group

p4 group [-a] name
p4 group -d [-a] name
p4 group -o name
p4 group -i [-a]

Create a group or modify the membership of an existing group.
A group can contain users and other groups. The group specification
is put into a temporary file and the editor (configured by the
environment variable $P4EDITOR) is invoked.

A group exists when it has any users or other groups in it, and
ceases to exist if all users and groups in it are removed.

Each group has MaxResults, MaxScanRows, and MaxLockTime fields,
which limit the resources committed to operations performed by
members of the group. For these fields, 'unlimited' or 'unset'
means no limit for that group. An individual user's limit is the
highest of any group with a limit to which he belongs, unlimited if
any of his groups has 'unlimited' for that field, or unlimited
if he belongs to no group with a limit. See 'p4 help maxresults'
for more information on MaxResults, MaxScanRows and MaxLockTime.

Each group also has a Timeout field, which specifies how long (in
seconds) a 'p4 login' ticket remains valid. A value of 'unset' or
'unlimited' is equivalent to no timeout. An individual's timeout is
the highest of any group with a limit to which he belongs, unlimited
if any of his groups has 'unlimited' for the timeout value, or
unlimited if he belongs to no group with a limit. See 'p4 help login'
for more information.

Each group has a PasswordTimeout field, which determines how long a
password remains valid for members of the group.

The -d flag deletes a group.

The -o flag writes the group specification to standard output. The
user's editor is not invoked.

The -i flag reads a group specification from standard input. The
user's editor is not invoked. The new group specification replaces
the previous one.

The -a flag enables a user without 'super' access to modify the group
if that user is an 'owner' of that group. Group owners are specified
in the 'Owners' field of the group spec.

All commands that require access granted by 'p4 protect' consider a
user's groups when calculating access levels.

'p4 group' requires 'super' access granted by 'p4 protect' unless
invoked with the '-a' flag by a qualified user.

Create a new group in the repository.

Group specification for the new group The Group object if new group was created, null if creation failed

Update the record for a group in the repository

Group specification for the group being updated The Group object if new group was saved, null if creation failed

Get the record for an existing group from the repository.

Group name There are no valid flags to use when fetching an existing group The Group object if new group was found, null if creation failed

Get a list of groups from the repository

options for the groups command A list containing the matching groups
p4 help groups

groups -- List groups (of users)

p4 groups [-m max] [[[-i] user | group] | [-v [group]]]

List all user groups defined in the server. If a user argument is,
specified, only groups containing that user are displayed. If a group
argument is specified, only groups containing the group are displayed.

The -i flag also displays groups that the user or group belongs to
indirectly by means of membership in subgroups.

The -m max flag limits output to the specified number of groups.

The -v flag displays the MaxResults, MaxScanRows, MaxLockTime, and
Timeout values for the specified group.

Delete a group from the repository

The group to be deleted

Create a new empty changelist object using a blank spec returned by the server

Id of the new changelist New changelist Guarantees that any custom values are set

Create a new empty changelist object using a blank spec returned by the server

New changelist Guarantees that any custom values are set

Create a new changelist in the repository.

Changelist specification for the new changelist '-s', '-f', -u flags are valid when creating a new user The Changelist object if new user was created, null if creation failed The '-i' flag is added if not specified by the caller

p4 help change

change -- Create or edit a changelist description
changelist -- synonym for 'change'

p4 change [-s] [-f | -u] [changelist#]
p4 change -d [-f -s] changelist#
p4 change -o [-s] [-f] [changelist#]
p4 change -i [-s] [-f | -u]
p4 change -t restricted | public [-f | -u] changelist#

'p4 change' creates and edits changelists and their descriptions.
With no argument, 'p4 change' creates a new changelist. If a
changelist number is specified, 'p4 change' edits an existing
pending changelist. In both cases, the changelist specification
is placed into a form and the user's editor is invoked.

The -d flag deletes a pending changelist, if it has no opened files
and no pending fixes associated with it. Use 'p4 opened -a' to
report on opened files and 'p4 reopen' to move them to another
changelist. Use 'p4 fixes -c changelist#' to report on pending
fixes and 'p4 fix -d -c changelist# jobs...' to delete pending
fixes. The changelist can be deleted only by the user and client
who created it, or by a user with 'admin' privilege using the -f
flag.

The -o flag writes the changelist specification to the standard
output. The user's editor is not invoked.

The -i flag reads a changelist specification from the standard
input. The user's editor is not invoked.

The -f flag forces the update or deletion of other users' pending
changelists. -f can also force the deletion of submitted changelists
after they have been emptied of files using 'p4 obliterate'. By
default, submitted changelists cannot be changed. The -f flag can
also force display of the 'Description' field in a restricted
changelist. The -f flag requires 'admin' access granted by 'p4
protect'. The -f and -u flags are mutually exclusive.

The -u flag can force the update of a submitted change by the owner
of the change. Only the Jobs, Type, and Description fields can be
changed using the -u flag. The -f and -u flags cannot be used in
the same change command.

The -s flag extends the list of jobs to include the fix status
for each job. On new changelists, the fix status begins as the
special status 'ignore', which, if left unchanged simply excludes
the job from those being fixed. Otherwise, the fix status, like
that applied with 'p4 fix -s', becomes the job's status when
the changelist is committed. Note that this option exists
to support integration with external defect trackers.

The -t flag changes the 'Type' of the change to 'restricted'
or 'public' without displaying the change form. This option is
useful for running in a trigger or script.

The 'Type' field can be used to hide the change or its description
from users. Valid values for this field are 'public' (default), and
'restricted'. A shelved or committed change that is 'restricted' is
accessible only to users who own the change or have 'list' permission
to at least one file in the change. A pending (not shelved) change
is accessible to its owner. Public changes are accessible to all
users. This setting affects the output of the 'p4 change',
'p4 changes', and 'p4 describe' commands.

If a user is not permitted to have access to a restricted change,
The 'Description' text is replaced with a 'no permission' message
(see 'Type' field). Users with admin permission can override the
restriction using the -f flag.

# A Perforce Change Specification. # # Change: The change number. 'new' on a new changelist. # Date: The date this specification was last modified. # Client: The client on which the changelist was created. Read-only. # User: The user who created the changelist. # Status: Either 'pending' or 'submitted'. Read-only. # Type: Either 'public' or 'restricted'. Default is 'public'. # Description: Comments about the changelist. Required. # Jobs: What opened jobs are to be closed by this changelist. # You may delete jobs from this list. (New changelists only.) # Files: What opened files from the default changelist are to be added # to this changelist. You may delete files from this list. # (New changelists only.)

Create a new change in the repository.

Changelist specification for the new change The Changelist object if new change was created, null if creation failed

Update the record for a change in the repository

Changelist specification for the change being updated The Changelist object if new change was saved, null if creation failed

Update the record for a submitted change in the repository

Changelist specification for the change being updated The Changelist object if new change was saved, null if creation failed

Get the record for an existing change from the repository.

Changelist name '-f' or '-s' are valid flags to use when fetching an existing change The Changelist object if new change was found, null if creation failed

Get a list of changes from the repository

options for the changes command A list containing the matching changes
p4 help changes

changes -- Display list of pending and submitted changelists
changelists -- synonym for 'changes'

p4 changes [options] [file[revRange] ...]

options: -i -t -l -L -f -c client -m max -s status -u user

Returns a list of all pending and submitted changelists currently
stored in the server.

If files are specified, 'p4 changes' lists only changelists that
affect those files. If the file specification includes a revision
range, 'p4 changes' lists only submitted changelists that affect
the specified revisions. See 'p4 help revisions' for details.

If files are not specified, 'p4 changes' limits its report
according to each change's type ('public' or 'restricted').
If a submitted or shelved change is restricted, the change is
not reported unless the user owns the change or has list
permission for at least one file in the change. Only the owner
of a restricted and pending (not shelved) change is permitted
to see it.

The -i flag also includes any changelists integrated into the
specified files.

The -t flag displays the time as well as the date.

The -l flag displays the full text of the changelist
descriptions.

The -L flag displays the changelist descriptions, truncated to 250
characters if longer.

The -f flag enables admin users to view restricted changes.

The -c client flag displays only submitted by the specified client.

The -m max flag limits changes to the 'max' most recent.

The -s status flag limits the output to pending, shelved or
submitted changelists.

The -u user flag displays only changes owned by the specified user.

Delete a change from the repository

The change to be deleted The '-f' and '-s' flags are valid when deleting an existing change

Create a new client in the repository.

Client specification for the new user The '-i' flags is required when creating a new user The Client object if new user was created, null if creation failed The '-i' flag is added if not specified by the caller

p4 help client

client -- Create or edit a client workspace specification and its view
workspace -- Synonym for 'client'

p4 client [-f -t template] [name]
p4 client -d [-f] name
p4 client -o [-t template] [name]
p4 client -S stream [[-c change] -o] [name]
p4 client -s [-f] -S stream [name]
p4 client -s [-f] -t template [name]
p4 client -i [-f]

Creates a new client specification ('spec') or edits an existing
spec. A client spec is a named mapping of depot files to workspace
files.

The 'p4 client' command puts the client spec into a temporary file
and invokes the editor configured by the environment variable
$P4EDITOR. For new workspaces, the client name defaults to the
$P4CLIENT environment variable, if set, or to the current host name.
Saving the file creates or modifies the client spec.

The client spec contains the following fields:

Client: The client name.

Host: If set, restricts access to the named host.
If unset, access is allowed from any host.

Owner: The user who created this client.

Update: The date that this spec was last modified.

Access: The date that this client was last used in any way.

Description: A short description of the workspace.

Root: The root directory of the workspace (specified in local
file system syntax), under which all versioned files
will be placed. If you change this setting, you must
physically relocate any files that currently reside
there. On Windows client machines, you can specify the
root as "null" to enable you to map files to multiple
drives.

AltRoots: Up to two optional alternate client workspace roots.
The first of the main and alternate roots to match the
client program's current working directory is used. If
none match, the main root is used. 'p4 info' displays
the root that is being used.

Options: Flags to configure the client behavior. Defaults
are marked with *.

allwrite Leaves all files writable on the client;
noallwrite * by default, only files opened by 'p4 edit'
are writable. If set, files might be clobbered
as a result of ignoring the clobber option
(see below).

clobber Permits 'p4 sync' to overwrite writable
noclobber * files on the client. noclobber is ignored if
allwrite is set.

compress Compresses data sent between the client
nocompress * and server to speed up slow connections.

locked Allows only the client owner to use or change
unlocked * the client spec. Prevents the client spec from
being deleted.

modtime Causes 'p4 sync' and 'p4 submit' to preserve
nomodtime * file modification time, as with files with the
+m type modifier. (See 'p4 help filetypes'.)
With nomodtime, file timestamps are updated by
sync and submit operations.

rmdir Makes 'p4 sync' attempt to delete a workspace
normdir * directory when all files in it are removed.

SubmitOptions: Flags to change submit behaviour.

submitunchanged All open files are submitted (default).

revertunchanged Files that have content or type changes
are submitted. Unchanged files are
reverted.

leaveunchanged Files that have content or type changes
are submitted. Unchanged files are moved
to the default changelist.

+reopen Can be appended to the submit option flag
to cause submitted files to be reopened in
the default changelist.
Example: submitunchanged+reopen

LineEnd: Set line-ending character(s) for client text files.

local mode that is native to the client (default).
unix linefeed: UNIX style.
mac carriage return: Macintosh style.
win carriage return-linefeed: Windows style.
share hybrid: writes UNIX style but reads UNIX,
Mac or Windows style.

View: Maps files in the depot to files in your client
workspace. Defines the files that you want in your
client workspace and specifies where you want them
to reside. The default view maps all depot files
onto the client. See 'p4 help views' for view syntax.
A new view takes effect on the next 'p4 sync'.

Stream: The stream to which this client's view will be dedicated.
(Files in stream paths can be submitted only by dedicated
stream clients.) When this optional field is set, the
View field will be automatically replaced by a stream
view as the client spec is saved.

Note: changing the client root does not actually move the client
files; you must relocate them manually. Similarly, changing
the 'LineEnd' option does not actually update the client files;
you can refresh them with 'p4 sync -f'.

The -d flag deletes the specified spec, as long as the client
workspace has no opened files or pending changes. (See 'p4 help
opened'.) The -f flag forces the delete.

The -o flag writes the named client spec to the standard output.
The user's editor is not invoked.

The -i flag reads a client spec from the standard input. The
user's editor is not invoked.

The -t template flag, where 'template' is the name of another client
spec, causes the View and Options fields to be replaced by those of
the template.

The -f flag can force the updating of locked clients; normally
locked clients can only be modified by their owner. -f also allows
the last modified date to be set. The -f flag requires 'admin'
access granted by 'p4 protect'.

The -s flag is used to switch an existing client spec's view without
invoking the editor. It can be used with -S to switch to a stream
view, or with -t to switch to a view defined in another client spec.
Switching views is not allowed in a client that has opened files.
The -f flag can be used with -s to force switching with opened files.
View switching has no effect on files in a client workspace until
'p4 sync' is run.

Without -s, the '-S stream' flag can be used to create a new client
spec dedicated to a stream. If the client spec already exists, and
-S is used without -s, it is ignored.

The '-S stream' flag can be used with '-o -c change' to inspect an
old stream client view. It yields the client spec that would have
been created for the stream at the moment the change was recorded.

Create a new client in the repository.

Client specification for the new client The Client object if new client was created, null if creation failed

Update the record for a client in the repository

Client specification for the client being updated The Client object if new client was saved, null if creation failed

Get the record for an existing client from the repository.

Client name There are no valid flags to use when fetching an existing client The Client object if new client was found, null if creation failed

Get a list of clients from the repository

options for the clients command A list containing the matching clients
p4 help clients

clients -- Display list of clients
workspaces -- synonym for 'clients'

p4 clients [-t] [-u user] [[-e|-E] nameFilter -m max] [-S stream]

Lists all client workspaces currently defined in the server.

The -t flag displays the time as well as the date.

The -u user flag lists client workspaces that are owned by the
specified user.

The -e nameFilter flag lists workspaces with a name that matches
the nameFilter pattern, for example: -e 'svr-dev-rel*'. -E makes
the matching case-insensitive.

The -m max flag limits output to the specified number of workspaces.

The -S stream flag limits output to the client workspaces dedicated
to the stream.

Delete a client from the repository

The client to be deleted Only the '-f' flag is valid when deleting an existing client

Create a repository on the specified server.

The repository server.///

Return a list of FileSpecs of files opened for specified changelists.

p4 help opened

opened -- List open files and display file status

p4 opened [-a -c changelist# -C client -u user -m max] [file ...]

Lists files currently opened in pending changelists, or, for
specified files, show whether they are currently opened or locked.
If the file specification is omitted, all files open in the current
client workspace are listed.

The -a flag lists opened files in all clients. By default, only
files opened by the current client are listed.

The -c changelist# flag lists files opened in the specified
changelist#.

The -C client flag lists files open in the specified client workspace.

The -u user flag lists files opened by the specified user.

The -m max flag limits output to the first 'max' number of files.

Get the File objects associated with the passed-in FileSpec list.

p4 help files

files -- List files in the depot

p4 files [ -a ] [ -A ] [ -m max ] file[revRange] ...

List details about specified files: depot file name, revision,
file, type, change action and changelist number of the current
head revision. If client syntax is used to specify the file
argument, the client view mapping is used to determine the
corresponding depot files.

By default, the head revision is listed. If the file argument
specifies a revision, then all files at that revision are listed.
If the file argument specifies a revision range, the highest revision
in the range is used for each file. For details about specifying
revisions, see 'p4 help revisions'.

The -a flag displays all revisions within the specific range, rather
than just the highest revision in the range.

The -A flag displays files in archive depots.

The -m flag limits files to the first 'max' number of files.

List selected directory paths in the repository.

p4 help dirs

dirs -- List depot subdirectories

p4 dirs [-C -D -H] [-S stream] dir[revRange] ...

List directories that match the specified file pattern (dir).
This command does not support the recursive wildcard (...).
Use the * wildcard instead.

Perforce does not track directories individually. A path is treated
as a directory if there are any undeleted files with that path as a
prefix.

By default, all directories containing files are listed. If the dir
argument includes a revision range, only directories containing files
in the range are listed. For details about specifying file revisions,
see 'p4 help revisions'.

The -C flag lists only directories that fall within the current
client view.

The -D flag includes directories containing only deleted files.

The -H flag lists directories containing files synced to the current
client workspace.

The -S flag limits output to depot directories mapped in a stream's
client view.

Return the contents of the files identified by the passed-in file specs.

GetFileContents
p4 help print

print -- Write a depot file to standard output

p4 print [-a -o localFile -q] file[revRange] ...

Retrieve the contents of a depot file to the client's standard output.
The file is not synced. If file is specified using client syntax,
Perforce uses the client view to determine the corresponding depot
file.

By default, the head revision is printed. If the file argument
includes a revision, the specified revision is printed. If the
file argument has a revision range, then only files selected by
that revision range are printed, and the highest revision in the
range is printed. For details about revision specifiers, see 'p4
help revisions'.

The -a flag prints all revisions within the specified range, rather
than just the highest revision in the range.

The -o localFile flag redirects the output to the specified file on
the client filesystem.

The -q flag suppresses the initial line that displays the file name
and revision.

Get the revision history data for the passed-in file specs.

See:
p4 help filelog

filelog -- List revision history of files

p4 filelog [-c changelist# -h -i -l -L -t -m maxRevs -s] file[revRange] ...

List the revision history of the specified files, from the most
recent revision to the first. If the file specification includes
a revision, the command lists revisions at or prior to the specified
revision. If the file specification includes a revision range,
the command lists only the specified revisions. See 'p4 help revisions'
for details.

The -c changelist# flag displays files submitted at the specified
changelist number.

The -i flag includes inherited file history. If a file was created by
branching (using 'p4 integrate'), filelog lists the revisions of the
file's ancestors up to the branch points that led to the specified
revision. File history inherited by renaming (using 'p4 move') is
always displayed regardless of whether -i is specified.

The -h flag displays file content history instead of file name
history. The list includes revisions of other files that were
branched or copied (using 'p4 integrate' and 'p4 resolve -at') to
the specified revision. Revisions that were replaced by copying
or branching are omitted, even if they are part of the history of
the specified revision.

The -t flag displays the time as well as the date.

The -l flag lists the full text of the changelist descriptions.

The -L flag lists the full text of the changelist descriptions,
truncated to 250 characters if longer.

The -m maxRevs displays at most 'maxRevs' revisions per file of
the file[rev] argument specified.

The -s flag displays a shortened form of filelog that omits
non-contributory integrations.

Get content and existence diff details for two depot files.

p4 help diff

diff -- Display diff of client file with depot file

p4 diff [-d<flags> -f -m max -s<flag> -t] [file[rev] ...]

On the client machine, diff a client file against the corresponding
revision in the depot. The file is compared only if the file is
opened for edit or a revision is provided. See 'p4 help revisions'
for details about specifying revisions.

If the file specification is omitted, all open files are diffed.
This option can be used to view pending changelists.

The -d<flags> modify the output as follows: -dn (RCS), -dc[n] (context),
-ds (summary), -du[n] (unified), -db (ignore whitespace changes),
-dw (ignore whitespace), -dl (ignore line endings). The optional
argument to -dc specifies number of context lines.

The -f flag diffs every file, regardless of whether they are opened
or the client has synced the specified revision. This option can be
used to verify the contents of the client workspace.

The -m max flag limits output to the first 'max' number of files,
unless the -s flag is used, in which case it is ignored.

The -s options lists the files that satisfy the following criteria:

-sa Opened files that differ from the revision
in the depot or are missing.

-sb Files that have been opened for integrate, resolved,
and subsequently modified.

-sd Unopened files that are missing on the client.

-se Unopened files that differ from the revision
in the depot.

-sl Every unopened file, along with the status of
'same, 'diff', or 'missing' as compared to the
corresponding revision in the depot.

-sr Opened files that do not differ from the revision in
the depot.

The -t flag forces 'p4 diff' to diff binary files.

If the environment variable $P4DIFF is set, the specified diff
program is launched in place of the default Perforce client diff.
The -d<flags> option can be used to pass arguments to the diff
program. Because the -s flag is only implemented internally, any
-d<flags> option used with the -s<flag> is ignored. To configure a
diff program for Unicode files, set the environment variable
$P4DIFFUNICODE. Specify the file's character set as the first
argument to the program.

Return FileAnnotation objects for the listed FileSpecs.

p4 help annotate

annotate -- Print file lines and their revisions

p4 annotate [-aciIq -d<flags>] file[revRange] ...

Prints all lines of the specified files, indicating the revision that
introduced each line into the file.

If the file argument includes a revision, then only revisions up to
the specified revision are displayed. If the file argument has a
revision range, only revisions within that range are displayed. For
details about specifying revisions, see 'p4 help revisions'.

The -a flag includes both deleted files and lines no longer present
at the head revision. In the latter case, both the starting and ending
revision for each line is displayed.

The -c flag directs the annotate command to output changelist numbers
rather than revision numbers for each line.

The -d<flags> change the way whitespace and/or line endings are
treated: -db (ignore whitespace changes), -dw (ignore whitespace),
-dl (ignore line endings).

The -i flag follows branches. If a file was created by branching,
'p4 annotate' includes the revisions of the source file up to the
branch point, just as 'p4 filelog -i' does. If a file has history
prior to being created by branching (such as a file that was branched
on top of a deleted file), -i ignores those prior revisions and
follows the source. -i implies -c.

The -I flag follows all integrations into the file. If a line was
introduced into the file by a merge, the source of the merge is
displayed as the changelist that introduced the line. If the source
itself was the result of an integration, that source is used instead,
and so on. -I implies -c.

The -q flag suppresses the one-line header that is displayed by
default for each file.

Tag depot files with the passed-in label.

p4 help tag

tag -- Tag files with a label

p4 tag [-d -n] -l label file[revRange] ...

Tag associates the named label with the file revisions specified by
the file argument. After file revisions are tagged with a label,
revision specifications of the form '@label' can be used to refer
to them.

If the file argument does not include a revision specification, the
head revisions is tagged. See 'p4 help revisions' for revision
specification options.

If the file argument includes a revision range specification, only
the files with revisions in that range are tagged. Files with more
than one revision in the range are tagged at the highest revision.

The -d deletes the association between the specified files and the
label, regardless of revision.

The -n flag previews the results of the operation.

Tag can be used with an existing label (see 'p4 help labels') or
with a new one. An existing label can be used only by its owner,
and only if it is unlocked. (See 'p4 help label').

To list the file revisions tagged with a label, use 'p4 files
@label'.

List fixes affecting files and / or jobs and / or changelists.

p4 help fixes

fixes -- List jobs with fixes and the changelists that fix them

p4 fixes [-i -m max -c changelist# -j jobName] [file[revRange] ...]

'p4 fixes' list fixed jobs and the number of the changelist that
contains the fix.Fixes are associated with changelists using the
'p4 fix' command or by editing and submitting changelists.

The 'p4 fixes' command lists both submitted and pending changelists.

By default, 'p4 fixes' lists all fixes. This list can be limited
as follows: to list fixes for a specified job, use the -j jobName
flag. To list fixes for a specified changelist, use -c changelist#.
To list fixes that affect specified files, include the file argument.
The file pattern can include wildcards and revision specifiers. For
details about revision specifiers, see 'p4 help revisions'

The -i flag also includes any fixes made by changelists integrated
into the specified files.

The -m max flag limits output to the specified number of job
fixes.

Get a list of matching lines in the passed-in file specs.

p4 help grep

grep -- Print lines matching a pattern

p4 grep [options] -e pattern file[revRange]...

options: -a -i -n -A <num> -B <num> -C <num> -t -s (-v|-l|-L) (-F|-G)

Searches files for lines that match the specified regular expression,
which can contain wildcards. The parser used by the Perforce server
is based on V8 regexp and might not be compatible with later parsers,
but the majority of functionality is available.

By default the head revision is searched. If the file argument includes
a revision specification, all corresponding revisions are searched.
If the file argument includes a revision range, only files in that
range are listed, and the highest revision in the range is searched.
For details about revision specifiers, see 'p4 help revisions'.

The -a flag searches all revisions within the specified range. By
default only the highest revision in the range is searched.

The -i flag causes the pattern matching to be case-insensitive. By
default, matching is case-sensitive.

The -n flag displays the matching line number after the file revision
number. By default, matches are displayed as revision#: <text>.

The -v flag displays files with non-matching lines.

The -F flag is used to interpret the pattern as a fixed string.

The -G flag is used to interpret the pattern as a regular expression,
which is the default behavior.

The -L flag displays the name of each selected file from which no
output would normally have been displayed. Scanning stops on the
first match.

The -l flag display the name of each selected file containing
matching text. Scanning stops on the first match.

The -s flag suppresses error messages that result from abandoning
files that have a maximum number of characters in a single line that
are greater than 4096. By default, an error is reported when grep
abandons such files.

The -t flag searches binary files. By default, only text files are
searched.

The -A <num> flag displays the specified number of lines of trailing
context after matching lines.

The -B <num> flag displays the specified number of lines of leading
context before matching lines.

The -C <num> flag displays the specified number of lines of output
context.

Regular expressions:

A regular expression is zero or more branches, separated by `|'. It
matches anything that matches one of the branches.

A branch is zero or more pieces, concatenated. It matches a match
for the first, followed by a match for the second, etc.

A piece is an atom possibly followed by `*', `+', or `?'. An atom
followed by `*' matches a sequence of 0 or more matches of the atom.
An atom followed by `+' matches a sequence of 1 or more matches of
the atom. An atom followed by `?' matches a match of the atom, or
the null string.

An atom is a regular expression in parentheses (matching a match for
the regular expression), a range (see below), `.' (matching any
single character), `^' (matching the null string at the beginning
of the input string), `$' (matching the null string at the end of
the input string), a `\' followed by a single character (matching
that character), or a single character with no other significance
(matching that character).

A range is a sequence of characters enclosed in `[]'. It normally
matches any single character from the sequence. If the sequence
begins with `^', it matches any single character not from the rest
of the sequence. If two characters in the sequence are separated by
`-', this is shorthand for the full list of ASCII characters between
them (e.g. `[0-9]' matches any decimal digit). To include a literal
`]' in the sequence, make it the first character (following a possible
`^'). To include a literal `-', make it the first or last character.

Get a list of submitted integrations for the passed-in file specs.

p4 help integrated

integrated -- List integrations that have been submitted

p4 integrated [-r] [-b branch] [file ...]

The p4 integrated command lists integrations that have been submitted.
To list unresolved integrations, use 'p4 resolve -n'. To list
resolved but unsubmitted integrations, use 'p4 resolved'.

If the -b branch flag is specified, only files integrated from the
source to target files in the branch view are listed. Qualified
files are listed, even if they were integrated without using the
branch view.

The -r flag reverses the mappings in the branch view, swapping the
target files and source files. The -b branch flag is required.

Get a list of Perforce protection entries for the passed-in file specs

p4 help protects

protects -- Display protections defined for a specified user and path

p4 protects [-a | -g group | -u user] [-h host] [-m] [file ...]

'p4 protects' displays the lines from the protections table that
apply to the current user. The protections table is managed using
the 'p4 protect' command.

If the -a flag is specified, protection lines for all users are
displayed. If the -g group flag or -u user flag is specified,
protection lines for that group or user are displayed.

If the -h host flag is specified, the protection lines that apply
to the specified host (IP address) are displayed.

If the -m flag is given, a single word summary of the maximum
access level is reported. Note that this summary does not take
exclusions into account.

If the file argument is specified, protection lines that apply to
the specified files are displayed.

The -a/-g/-u flags require 'super' access granted by 'p4 protect'.

List Perforce users assigned to review files.

p4 help reviews

reviews -- List the users who are subscribed to review files

p4 reviews [-c changelist#] [file ...]

'p4 reviews' lists all users who have subscribed to review the
specified files, the files in the specified changelist, or all files
(the default). To subscribe to review files, issue the 'p4 user'
command and edit the 'Reviews field'.

Get a FormSpec of the specified form type.

p4 help spec

spec -- Edit spec definitions (unsupported)

p4 spec [-d -i -o] type

Edit any type of specification: branch, change, client, depot,
group, job, label, spec, stream, trigger, typemap, or user. Only
the comments and the formatting hints can be changed. Any fields
that you add during editing are discarded when the spec is saved.

'p4 jobspec' is equivalent to 'p4 spec job', and any custom spec
(include the job spec) can be deleted with 'p4 spec -d type'.

Get the repository's trigger table.

p4 help triggers

triggers -- Modify list of server triggers

p4 triggers
p4 triggers -o
p4 triggers -i

'p4 triggers' edits the table of triggers, which are used for
change submission validation, form validation, external authentication,
external job fix integration, and external archive integration.

Triggers are administrator-defined commands that the server runs
to perform the following:

Validate changelist submissions.

The server runs changelist triggers before the file transfer,
between file transfer and changelist commit, or after the commit

Validate shelve operations.

The server runs shelve triggers before files are shelved, after
files are shelved, or when shelved files have been discarded
(via shelve -d).

Manipulate and validate forms.

The server runs form-validating triggers between generating
and outputting the form, between inputting and parsing the
form, between parsing and saving the form, or when deleting
the form.

Authenticate or change a user password.

The server runs authentication triggers to either validate
a user password during login or when setting a new password.

Intercept job fix additions or deletions.

The server run fix triggers prior to adding or deleting a fix
between a job and changelist.

Access external archive files.

For files with the +X filetype modifier, the server runs an
archive trigger to read, write, or delete files in the archive.

The trigger form has a single entry 'Triggers', followed by any
number of trigger lines. Triggers are executed in the order listed
and if a trigger fails, subsequent triggers are not run. A trigger
succeeds if the executed command exits returning 0 and fails otherwise.
Normally the failure of a trigger prevents the operation from
completing, except for the commit triggers, which run after the
operation is complete.

Each trigger line contains a trigger name, a trigger type, a depot
file path pattern or form type, and a command to run.

Name: The name of the trigger. For change triggers, a run of the
same trigger name on contiguous lines is treated as a single
trigger so that multiple paths can be specified. Only the
command of the first such trigger line is used.

Type: When the trigger is to execute:

archive:
Execute an archive trigger for the server to access
any file with the +X filetype modifier.

auth-check:
service-check:
Execute an authentication check trigger to verify a
user's password against an external password manager
during login or when setting a new password.

auth-check-sso:
Facilitate a single sign-on user authentication. This
configuration requires two programs or scripts to run;
one on the client, the other on the server.

client:
Set the environment variable 'P4LOGINSSO' to point to
a script that can be executed to obtain the user's
credentials or other information that the server
trigger can verify. The client-side script must
write the message to the standard output
(max length 128K).

Example: P4LOGINSSO=/Users/joe/bin/runsso

The 'server address' can be optionally passed to the
client script by appending %serverAddress% to the
client command string, as in:

P4LOGINSSO="/Users/joe/bin/runsso %serverAddress%"

server:
Execute an authentication (sso) trigger that gets
this message from the standard input and returns an
exit status of 0 (for verified) or otherwise failed.

Example:
sso auth-check-sso auth "/secure/verify %user%"

The user must issue the 'p4 login' command, but no
password prompting is invoked. If the server
determines that the user is valid, they are issued a
Perforce ticket just as if they had logged in with a
password.

Pre-2007.2 clients cannot run a client-side single
sign-on. Specifying an 'auth-check' trigger as a backup
for a user to gain access will prompt the user for a
password if it's an older client or P4LOGINSSO has not
been configured.

Unlike passwords which are encrypted, the sso message is
sent to the server in clear text.

auth-set:
Execute an authentication set trigger to send a new
password to an external password manager.

change-submit:
Execute pre-submit trigger after changelist has been
created and files locked but prior to file transfer.

change-content:
Execute mid-submit trigger after file transfer but prior
to commit. Files can be accessed by the 'p4 diff2',
'p4 files', 'p4 fstat', and 'p4 print' commands using
the revision specification '@=change', where 'change' is
the pending changelist number passed as %changelist%.

change-commit:
Execute post-submit trigger after changelist commit.

fix-add:
Execute fix trigger prior to adding a fix. The special
variable %jobs% is available for expansion and must be
the last argument to the trigger as it expands to one
argument for each job listed on the 'p4 fix' command.

fix-delete:
Execute fix trigger prior to deleting a fix. The special
variable %jobs% is available for expansion and must be
the last argument to the trigger as it expands to one
argument for each job listed on the 'p4 fix -d' command.

form-out:
Execute form trigger on generation of form. Trigger may
modify form.

form-in:
Execute form trigger on input of form before its contents
are parsed and validated. Trigger may modify form.

form-save:
Execute form trigger prior to save of form after its
contents are parsed.

form-commit:
Execute form trigger after it has been committed, allowing
access to automatically generated fields (jobname, dates
etc). It cannot modify the form. This trigger for job
forms is run by 'p4 job' and 'p4 fix' (after the status
is updated), 'p4 change' (if the job is added or deleted)
and 'p4 submit' (if the job is associated with the change).
The 'form-commit' trigger has access to the new job name
created with 'p4 job', while the 'form-in' and 'form-save'
triggers are run before the job name is created. The
special variable %action% is available on the job
'form-commit' trigger command line, and is expanded when
the job is modified by a fix.

form-delete:
Execute form trigger prior to delete of form after its
contents are parsed.

shelve-submit:
Execute pre-shelve trigger after changelist has been
created but prior to file transfer.

shelve-commit:
Execute post-shelve trigger after files are shelved.

shelve-delete:
Execute shelve trigger prior to discarding shelved files.

Path: For change and submit triggers, a file pattern to match files
in the changelist. This file pattern can be an exclusion
mapping (-pattern), to exclude files. For form triggers, the
name of the form (branch, client, etc). For fix triggers
'fix' is required as the path value. For authentication
triggers, 'auth' is required as the path value. For archive
triggers, a file pattern to match the name of the file being
accessed in the archive. Note that, due to lazy copying when
branching files, the name of the file in the archive can not
be the same as the name of the file in the depot.

Command: The OS command to run for validation. If the command
contains spaces, enclose it in double quotes. The
following variables are expanded in the command string:

%client% -- the client issuing the command
%clienthost% -- the hostname of the client
%clientip% -- the IP address of the client
%serverhost% -- the hostname of the server
%serverip% -- the IP address of the server
%serverport% -- the IP address:port of the server
%serverroot% -- the value of the server's $P4ROOT
%user% -- the user issuing the command

%changelist% -- the changelist being submitted
%changeroot% -- the root path of files submitted
%oldchangelist% -- the pre-commit changelist number

(More information can be gathered about the
changelist being submitted by running
'p4 describe %changelist%'.)

%formfile% -- path to temp file containing form
%formname% -- the form's name (branch name, etc)
%formtype% -- the type of form (branch, etc)
%action% -- added/deleted/submitted on job form-commit

%jobs% -- list of job names for fix triggers

%op% -- read/write/delete for archive access
%file% -- name of archive file
%rev% -- revision of archive file

The command's standard input is empty for change, shelve,
fix, and auth triggers; it is the form contents for form
triggers; and it is the file content for the archive trigger.

If the command fails, the command's standard output (not
error output) is sent to the client as the text of a trigger
failure error message.

If the command succeeds, the command's standard output is
sent as an unadorned message to the client for all triggers
except archive triggers; for archive triggers, the command's
standard output is the file content.

The -o flag writes the trigger table to the standard output.
The user's editor is not invoked.

The -i flag reads the trigger table from the standard input.
The user's editor is not invoked.

'p4 triggers' requires 'super' access granted by 'p4 protect'.

Get the repository's type map.

runs the command p4 typemap -o
p4 help typemap

typemap -- Edit the filename-to-filetype mapping table

p4 typemap
p4 typemap -o
p4 typemap -i

'p4 typemap' edits a name-to-type mapping table for 'p4 add', which
uses the table to assign a file's filetype based on its name.

The typemap form has a single field, 'TypeMap', followed by any
number of typemap lines. Each typemap line contains a filetype
and a depot file path pattern:

Filetype: See 'p4 help filetypes' for a list of valid filetypes.

Path: Names to be mapped to the filetype. The mapping is
a file pattern in depot syntax. When a user adds a file
matching this pattern, its default filetype is the
file type specified in the table. To exclude files from
the typemap, use exclusionary (-pattern) mappings.
To match all files anywhere in the depot hierarchy,
the pattern must begin with '//...'. To match files
with a specified suffix, use '//.../*.suffix' or
use '//....suffix' (four dots).

Later entries override earlier entries. If no matching entry is found
in the table, 'p4 add' determines the filetype by examining the file's
contents and execution permission bits.

The -o flag writes the typemap table to standard output. The user's
editor is not invoked.

The -i flag reads the typemap table from standard input. The user's
editor is not invoked.

'p4 typemap' requires 'admin' access, which is granted by 'p4 protect'.

Get the repository's protection table.

p4 help protect

protect -- Modify protections in the server namespace

p4 protect
p4 protect -o
p4 protect -i

'p4 protect' edits the protections table in a text form.

Each line in the table contains a protection mode, a group/user
indicator, the group/user name, client host ID and a depot file
path pattern. Users receive the highest privilege that is granted
on any line.

Note: remote depot are accessed using the pseudo-user 'remote'.
To control access from other servers that define your server as
a remote server, grant appropriate permissions to the 'remote' user.

Mode: The permission level or right being granted or denied.
Each permission level includes all the permissions above
it, except for 'review'. Each permission only includes
the specific right and no lesser rights. This approach
enables you to deny individual rights without having to
re-grant lesser rights. Modes prefixed by '=' are rights.
All other modes are permission levels.

Valid modes are:

list - users can see names but not contents of files;
users can see all non-file related metadata
(clients, users, changelists, jobs, etc.)

read - users can sync, diff, and print files

open - users can open files (add, edit. delete,
integrate)

write - users can submit open files

admin - permits those administrative commands and
command options that don't affect the server's
security.

super - access to all commands and command options.

review - permits access to the 'p4 review' command;
implies read access

=read - if this right is denied, users can't sync,
diff, or print files

=branch - if this right is denied, users are not
permitted to use files as a source
for 'p4 integrate'

=open = if this right is denied, users cannot open
files (add, edit, delete, integrate)

=write = if this right is denied, users cannot submit
open files

Group/User indicator: specifies the grantee is a group or user.

Name: A Perforce group or user name; can include wildcards.

Host: The IP address of a client host; can include wildcards.

Path: The part of the depot to which access is being granted
or denied. To deny access to a depot path, preface the
path with a "-" character. These exclusionary mappings
apply to all access levels, even if only one access
level is specified in the first field.

The -o flag writes the protection table to the standard output.
The user's editor is not invoked.

The -i flag reads the protection table from the standard input.
The user's editor is not invoked.

After protections are defined, 'p4 protect' requires 'super'
access.

Get the Perforce counters for this repository.

p4 help counters

counters -- Display list of known counters

p4 counters

Lists the counters in use by the server. The server
uses the following counters directly:

change Current change number
job Current job number
journal Current journal number
lastCheckpointAction Data about the last complete checkpoint
logger Event log index used by 'p4 logger'
traits Internal trait lot number used by 'p4 attribute'
upgrade Server database upgrade level

Other counters can be created by the 'p4 counter' or 'p4 review'
commands.

The names 'minClient', 'minClientMessage', 'monitor',
'security', and 'unicode' are reserved names: do not use them
as ordinary counters.

For general-purpose server configuration, see 'p4 help configure'.

Get a named Perforce counter value from the repository.

p4 help counter

counter -- Display, set, or delete a counter

p4 counter name
p4 counter [-f] name value
p4 counter [-f] -d name
p4 counter [-f] -i name

The first form displays the value of the specified counter.

The second form sets the counter to the specified value.

The third form deletes the counter. This option usually has the
same effect as setting the counter to 0.

The -f flag sets or deletes counters used by Perforce, which are
listed by 'p4 help counters'. Important: Never set the 'change'
counter to a value that is lower than its current value.

The -i flag increments a counter by 1 and returns the new value.
This option is used instead of a value argument and can only be
used with numeric counters.

Counters can be assigned textual values as well as numeric ones,
despite the name 'counter'.

'p4 counter' requires 'review' access granted by 'p4 protect'.
The -f flag requires that the user be an operator or have 'super'
access.

Delete a Perforce counter from the repository.

Create a new label in the repository.

Label specification for the new label The '-i' flag is required when creating a new label The Label object if new label was created, null if creation failed The '-i' flag is added if not specified by the caller

p4 help label

label -- Create or edit a label specification

p4 label [-f -t template] name
p4 label -d [-f] name
p4 label -o [-t template] name
p4 label -i [-f]

Create or edit a label. The name parameter is required. The
specification form is put into a temporary file and the editor
(configured by the environment variable $P4EDITOR) is invoked.

The label specification form contains the following fields:

Label: The label name (read only.)

Owner: The user who created this label. Can be changed.

Update: The date that this specification was last modified.

Access: The date of the last 'labelsync' or use of '@label'
referencing this label.

Description: A short description of the label (optional).

Options: Flags to change the label behavior.

locked Prevents users other than the label owner
from changing the specification. Prevents
the label from being deleted. Prohibits
'p4 labelsync'.

Revision: An optional revision specification for an automatic
label. Enclose in double quotes if it contains the
# (form comment) character.

View: A mapping that selects files from the depot. The
default view selects all depot files. Only the left
side of the mapping is used for labels.

A label is a named collection of revisions. A label is either
automatic or static. An automatic label refers to the revisions
given in the View: and Revision: fields. A static label refers to
the revisions that are associated with the label using the 'p4 tag'
or 'p4 labelsync' commands. A static label cannot have a Revison:
field. See 'p4 help revisions' for information on using labels as
revision specifiers.

Flag -d deletes the specified label. You cannot delete a locked label.
The -f flag forces the delete.

The -o flag writes the label specification to standard output. The
user's editor is not invoked.

The -i flag reads a label specification from standard input. The
user's editor is not invoked.

The -t flag copies the view and options from the template label to
the new label.

The -f flag forces the deletion of a label. By default, locked labels
can only be deleted by their owner. The -f flag also permits the
Last Modified date to be set. The -f flag requires 'admin' access,
which is granted by 'p4 protect'.

Create a new label in the repository.

Label specification for the new label The Label object if new label was created, null if creation failed

Update the record for a label in the repository

Label specification for the label being updated The Label object if new depot was saved, null if creation failed

Get the record for an existing label from the repository.

Label name Flags used when fetching an existing label The Label object if label was found, null if creation failed

Get a list of labels from the repository

A list containing the matching labels
p4 help labels

labels -- Display list of defined labels

p4 labels [-t] [-u user] [[-e|-E] nameFilter -m max] [file[revrange]]

Lists labels defined in the server.

If files are specified, 'p4 labels' lists the labels that contain
those files. If you include a file specification, automatic lablels
are omitted from the list. If the file specification includes a
revision range, 'p4 labels' lists labels that contain the specified
revisions. See 'p4 help revisions for details about specifying
revisions.

The -t flag displays the time as well as the date.

The -u user flag lists labels owned by the specified user.

The -e nameFilter flag lists labels with names that match the
the nameFilter pattern, for example: -e 'svr-dev-rel*'. -E makes
the matching case-insensitive.

The -m max flag limits output to the first 'max' number of labels.

Delete a label from the repository

The label to be deleted The 'f' and '-d' flags are valid when deleting an existing label

Create a new stream in the repository.

Stream specification for the new stream The '-i' flag is required when creating a new stream The Stream object if new stream was created, null if creation failed The '-i' flag is added if not specified by the caller

p4 help stream

stream -- Create, delete, or modify a stream specification

p4 stream [-P parent] -t type name
p4 stream [-f] [-d] [-o [-v]] [-P parent] -t type name
p4 stream -i [-f]

A stream specification ('spec') names a path in a stream depot to be
treated as a stream. (See 'p4 help streamintro'.) The spec also
defines the stream's lineage, its view, and its expected flow of
change.

The 'p4 stream' command puts the stream spec into a temporary file and
invokes the editor configured by the environment variable $P4EDITOR.
When creating a stream, the type of the stream must be specified with
the '-t' flag. Saving the file creates or modifies the stream spec.

Creating a stream spec does not branch a new stream. To branch a
stream, use 'p4 copy -r -S stream', where 'stream' is the name of a
stream spec.

The stream spec contains the following fields:

Stream: The stream's path in a stream depot, of the form
//depotname/streamname. This is both the name of the stream
spec and the permanent, unique identifier of the stream.

Update: The date this stream spec was last changed.

Access: The date of the last command used with this spec.

Owner: The stream's owner. Can be changed.

Name: An alternate name of the stream, for use in display outputs.
Defaults to the 'streamname' portion of the stream path.
Can be changed.

Parent: The parent of this stream. Can be 'none' if the stream type
is 'mainline', otherwise must be set to an existing stream
identfier, of the form //depotname/streamname.
Can be changed.

Type: 'mainline', 'development', or 'release'. Default is
'development'. Defines the expected flow of change between
a stream and its parent: A development stream expects to
merge from the parent and copy to the parent; a release
stream expects to copy from the parent and merge to the
parent. Can be changed

Description: An optional description of the stream.

Options: Flags to configure stream behavior. Defaults are marked *:

unlocked * Indicates whether the stream spec is locked
locked against modifications. If locked, the spec
may not be deleted, and only its owner may
modify it.

allsubmit * Indicates whether all users or only the
ownersubmit of the stream may submit changes to the
stream path.

toparent * Indicates whether integration from the
notoparent stream to its parent is expected to occur.

fromparent * Indicates whether integration to the stream
nofromparent from its parent is expected to occur.

Paths: One or more lines that define file paths in the stream view.
Each line is of the form:

<path_type> <view_path> [<depot_path>]

where <path_type> is a single keyword, <view_path> is a file
path with no leading slashes, and the optional <depot_path>
is a file path beginning with '//'. Both <view_path> and
<depot_path> may contain trailing wildcards, but no leading
or embedded wildcards. Lines in the Paths field may appear
in any order. A duplicated <view_path> overrides its
preceding entry.

For example:

share src/...
import lib/abc/... //over/there/abc/...
isolate bin/*

Default is:

share ...

The <path_type> keyword must be one of:

share: <view_path> will be included in client views and
in branch views. Files in this path are accessible
to workspaces, can be submitted to the stream, and
can be integrated with the parent stream.

isolate: <view_path> will be included in client views but
not in branch views. Files in this path are
accessible to workspaces, can be submitted to the
stream, but are not integratable with the parent
stream.

import: <view_path> will be included in client views but
not in branch views. Files in this path are mapped
as in the parent stream's view (the default) or to
<depot_path> (optional); they are accessible to
workspaces, but can not be submitted or integrated
to the stream.

exclude: <view_path> will be excluded from client views
and branch views. Files in this path are not
accessible to workspaces, and can't be submitted
or integrated to the stream.

Paths are inherited by child stream views. A child stream's
paths can downgrade the inherited view, but not upgrade it.
(For instance, a child stream can downgrade a shared path to
an isolated path, but it can't upgrade an isolated path to a
shared path.) Note that <depot_path> is relevant only when
<path_type> is 'import'.

Remapped: Optional; one or more lines that define how stream view paths
are to be remapped in client views. Each line is of the form:

<view_path_1> <view_path_2>

where <view_path_1> and <view_path_2> are Perforce view paths
with no leading slashes and no leading or embedded wildcards.
For example:

... x/...
y/* y/z/*

Line ordering in the Remapped field is significant; if more
than one line remaps the same files, the later line has
precedence. Remapping is inherited by child stream client
views.

Ignored: Optional; a list of file or directory names to be ignored in
client views. For example:

/tmp # ignores files named 'tmp'
/tmp/... # ignores dirs named 'tmp'
.tmp # ignores file names ending in '.tmp'

Lines in the Ignored field may appear in any order. Ignored
names are inherited by child stream client views.

The -d flag causes the stream spec to be deleted. A stream spec may
not be deleted if it is referenced by child streams or stream clients.
Deleting a stream spec does not remove stream files, but it does mean
changes can no longer be submitted to the stream's path.

The -o flag causes the stream spec to be written to the standard
output. The user's editor is not invoked. -v may be used with -o to
expose the automatically generated client view for this stream.
('p4 help branch' describes how to expose the branch view.)

The -P flag can be used to insert a value into the Parent field of a
new stream spec. It has no effect on an existing spec.

The -t flag is used to insert a value into the type field of a
new stream spec and to adjust the default fromparent option
for a new 'release' -type stream. The flag has no effect on an
existing spec.

The -i flag causes a stream spec to be read from the standard input.
The user's editor is not invoked.

The -f flag allows a user other than the owner to modify or delete a
locked stream. It requires 'admin' access granted by 'p4 protect'.

Create a new stream in the repository.

Stream specification for the new stream The Stream object if new stream was created, null if creation failed

Update the record for a stream in the repository

Stream specification for the stream being updated The Stream object if new stream was saved, null if creation failed

Get the record for an existing stream from the repository.

Stream name There are no valid flags to use when fetching an existing stream The Stream object if new stream was found, null if creation failed

Delete a stream from the repository

The stream to be deleted Only the '-f' flag is valid when deleting an existing stream

Create a new user in the repository.

User specification for the new user The '-f' and '-i' flags are required when creating a new user The User object if new user was created, null if creation failed The '-f' and '-i' flags are added if not specified by the caller

p4 help user

user -- Create or edit a user specification

p4 user [-f] [name]
p4 user -d [-f] name
p4 user -o [name]
p4 user -i [-f]

Create a new user specification or edit an existing user specification.
The specification form is put into a temporary file and the editor
(configured by the environment variable $P4EDITOR) is invoked.

Normally, a user specification is created automatically the first
time that the user issues any command that updates the depot. The
'p4 user' command is typically used to edit the user's subscription
list for change review.

The user specification form contains the following fields:

User: The user name (read-only).

Email: The user's email address (Default: user@client).

Update: The date the specification was last modified (read-only).

Access: The date that the user last issued a client command.

FullName: The user's real name.

JobView: Selects jobs that are displayed when the user creates
a changelist. These jobs can be closed automatically
when the user submits the changelist. For a description
of jobview syntax, see 'p4 help jobview'

Reviews: The subscription list for change review. There is no
limit on the number of lines that this field can contain.
You can include the following wildcards:

... matches any characters including /
* matches any character except /

Password: The user's password. See 'p4 help passwd'.

Type: Must be 'service', operator, or 'standard'. Default is
'standard'. Once set, the user type cannot be changed.

The -d flag deletes the specified user (unless the user has files
open).

The -o flag writes the user specification to the standard output.
The user's editor is not invoked.

The -i flag reads a user specification from the standard input.
The user's editor is not invoked.

The -f flag forces the creation, update or deletion of the specified
user, and enables you to change the Last Modified date. By default,
users can only delete or modify their own user specifications. The
-f flag requires 'super' access, which is granted by 'p4 protect'.

Create a new user in the repository.

User specification for the new user The User object if new user was created, null if creation failed

Update the record for a user in the repository

User specification for the user being updated The User object if new user was saved, null if creation failed

Get the record for an existing user from the repository.

User name There are no valid flags to use when fetching an existing user The User object if new user was found, null if creation failed

Get a list of users from the repository

Options for the users command. See: Optional list of users. A list containing the matching users
p4 help users

users -- List Perforce users

p4 users [-l -a -r -c] [-m max] [user ...]

Lists all Perforce users or users that match the 'user' argument.
The report includes the last time that each user accessed the system.

The -m max flag limits output to the first 'max' number of users.

The -a flag includes service and operator users in the output.

The -l flag includes additional information in the output. The -l
flag requires 'super' access, which is granted by 'p4 protect'.

The -r and -c flags are only allowed on replica servers. When
-r is given only users who have used a replica are reported and
when -c is given only the user information from the central server
is reported. Otherwise on a replica server, the user list will
be slightly different from the master server as the user access times
will reflect replica usage or master usage whichever is newer.

To get the first 10 users that start with the letter 'A':

 
            		
            		Options opts = new Options(UsersCmdFlags.None, 10);
            		IList<User> users = _repository.getUsers(opts, "A*");

To get the users for 'Bob', 'Ted', "Carol' and 'Alice':

 
            		
            		Options opts = new Options(UsersCmdFlags.None, -1);
            		IList<User> users = _repository.getUsers(opts, "Bob", "Ted", "Carol", "Alice");

To get all the users (WARNING, will fetch all users from the repository):

 
            					
            		Options opts = new Options(UsersCmdFlags.IncludeAll, -1);
            		IList<User> users = _repository.getUsers(opts);

Delete a user from the repository

The user to be deleted Only the '-f' flag is valid when deleting an existing user

Class representing the results of executing a command on a Perforce Server.

Create a P4CommandResult by running a command

Command to run Flags for the command

Create a P4CommandResult by running a command

Command to run

Did the command not return any errors?

The info results (if any) of the command execution

The errors (if any) of the command execution

The text output from the command

The tagged output of the command

A branch view specification in a Perforce repository.

The date of the last command used with this spec. A description of the branch spec (optional). The branch spec name (read only). When true, permits only the owner to change the spec. Flags to change the branch spec behavior. The user who created this branch spec. Specifies structural and semantic metadata for form types. The date this branch spec was last modified. Lines mapping of one view of depot files to another.

Read the fields from the tagged output of a branch command

Tagged output from the 'branch' command

Parse the fields from a branch specification

Text of the branch specification in server format

Format of a branch specification used to save a branch to the server

Convert to specification in server format

Read the fields from the tagged output of a branches command

Tagged output from the 'branches' command

The branch spec name (read only).

The user who created this branch spec. Can be changed.

The date this branch spec was last modified.

The date of the last command used with this spec.

A description of the branch spec (optional).

When true, permits only the owner to change the spec.

Lines mapping of one view of depot files to another.

Specifies structural and semantic metadata for form types.

Flags to change the branch spec behavior.

Shelved file information from a Describe -S command

A changelist specification in a Perforce repository.

Create a new pending changelist

Create a new numbered changelist

Fill in the fields for the changelist using the tagged output of a "change' command

The tagged output of a "change' command

Fill in the fields for the changelist using the tagged output of a "change' command

The tagged output of a "change' command

Parse the fields from a changelist specification

Text of the changelist specification in server format

Format of a user specification used to save a user to the server

Convert to specification in server format

Convert to a string for display

Include the time as well as the date

p4 help fix

fix -- Mark jobs as being fixed by the specified changelist

p4 fix [-d] [-s status] -c changelist# jobName ...

'p4 fix' marks each named job as being fixed by the changelist
number specified with -c. The changelist can be pending or
submitted and the jobs can open or closed (fixed by another
changelist).

If the changelist has already been submitted and the job is still
open, then 'p4 fix' marks the job closed. If the changelist has not
been submitted and the job is still open, the job is closed when the
changelist is submitted. If the job is already closed, it remains
closed.

The -d flag deletes the specified fixes. This operation does not
otherwise affect the specified changelist or jobs.

The -s flag uses the specified status instead of the default defined
in the job specification. This status is reported by 'p4 fixes'.
The 'p4 fix' and 'p4 change' (of a submitted changelist) and 'p4 submit'
(of a pending changelist) commands set the job's status to the fix's
status for each job associated with the change. If the fix's status
is 'same', the job's status is left unchanged.

Flags to configure the client behavior.

No options.

Leaves all files writable on the client; by default, only files opened by 'p4 edit' are writable. If set, files might be clobbered as a result of ignoring the clobber option.

Permits 'p4 sync' to overwrite writable files on the client. noclobber is ignored if allwrite is set.

Compresses data sent between the client and server to speed up slow connections.

Allows only the client owner to use or change the client spec. Prevents the client spec from being deleted.

Causes 'p4 sync' and 'p4 submit' to preserve file modification time, as with files with the +m type modifier. (See 'p4 help filetypes'.) With nomodtime, file timestamps are updated by sync and submit operations.

Makes 'p4 sync' attempt to delete a workspace directory when all files in it are removed.

Convert to a client spec formatted string

Parse a client spec formatted string

Flags to change submit behavior.

All open files are submitted (default).

Files that have content or type changes are submitted. Unchanged files are reverted.

Files that have content or type changes are submitted. Unchanged files are moved to the default changelist.

Client options that define what to do with files upon submit.

Convert to a client spec formatted string

Parse a client spec formatted string

Determines if the files is reopened upon submit.

Sets line-ending character(s) for client text files.

mode that is native to the client (default).

linefeed: UNIX style.

carriage return: Macintosh style.

carriage return-linefeed: Windows style.

hybrid: writes UNIX style but reads UNIX, Mac or Windows style.

A client specification in a Perforce repository.

Parse the tagged output of a 'clients' command

Parse the tagged output of a 'client' command

Parse a client spec

Utility function to format a DateTime in the format expected in a spec

Format as a client spec

p4 help add

add -- Open a new file to add it to the depot

p4 add [-c changelist#] [-d -f -n] [-t filetype] file ...

Open a file for adding to the depot. If the file exists on the
client, it is read to determine if it is text or binary. If it does
not exist, it is assumed to be text. To be added, the file must not
already reside in the depot, or it must be deleted at the current
head revision. Files can be deleted and re-added.

To associate the open files with a specific pending changelist, use
the -c flag; if you omit the -c flag, the open files are associated
with the default changelist. If file is already open, it is moved
into the specified pending changelist. You cannot reopen a file for
add unless it is already open for add.

As a shortcut to reverting and re-adding, you can use the -d
flag to reopen currently-open files for add (downgrade) under
the following circumstances:

A file that is 'opened for edit' and is synced to the head
revision, and the head revision has been deleted (or moved).

A file that is 'opened for move/add' can be downgraded to add,
which is useful when the source of the move has been deleted
or moved. Typically, under these circumstances, your only
alternative is to revert. In this case, breaking the move
connection enables you to preserve any content changes in the
new file and safely revert the source file (of the move).

To specify file type, use the -t flag. By default, 'p4 add'
determines file type using the name-to-type mapping table managed
by 'p4 typemap' and by examining the file's contents and execute
permission bit. If the file type specified by -t or configured in
the typemap table is a partial filetype, the resulting modifier is
applied to the file type that is determined by 'p4 add'. For more
details, see 'p4 help filetypes'.

To add files with filenames that contain wildcard characters, specify
the -f flag. Filenames that contain the special characters '@', '#',
'%' or '*' are reformatted to encode the characters using ASCII
hexadecimal representation. After the files are added, you must
refer to them using the reformatted file name, because Perforce
does not recognize the local filesystem name.

The -n flag displays a preview of the specified add operation without
changing any files or metadata.

p4 help delete

delete -- Open an existing file for deletion from the depot

p4 delete [-c changelist#] [-n -v -k] file ...

Opens a depot file for deletion.
If the file is synced in the client workspace, it is removed. If a
pending changelist number is specified using with the -c flag, the
file is opened for delete in that changelist. Otherwise, it is opened
in the default pending changelist.

Files that are deleted generally do not appear on the have list.

The -n flag displays a preview of the operation without changing any
files or metadata.

The -v flag enables you to delete files that are not synced to the
client workspace.

The -k flag performs the delete on the server without modifying
client files. Use with caution, as an incorrect delete can cause
discrepancies between the state of the client and the corresponding
server metadata.

p4 help edit

edit -- Open an existing file for edit

p4 edit [-c changelist#] [-k -n] [-t filetype] file ...

Open an existing file for edit. The server records the fact that
the current user has opened the file in the current workspace, and
changes the file permission from read-only to read/write.

If -c changelist# is included, the file opened in the specified
pending changelist. If changelist number is omitted, the file is
opened in the 'default' changelist.

If -t filetype is specified, the file is assigned that Perforce
filetype. Otherwise, the filetype of the previous revision is reused.
If a partial filetype is specified, it is combined with the current
filetype.For details, see 'p4 help filetypes'.
Using a filetype of 'auto' will cause the filetype to be choosen
as if the file were being added, that is the typemap will be
considered and the file contents may be examined.

The -n flag previews the operation without changing any files or
metadata.

The -k flag updates metadata without transferring files to the
workspace. This option can be used to tell the server that files in
a client workspace are already editable, even if they are not in the
client view. Typically this flag is used to correct the Perforce
server when it is wrong about the state of files in the client
workspace, but incorrect use of this option can result in inaccurate
file status information.

p4 help have

have -- List the revisions most recently synced to the current workspace

p4 have [file ...]

List revision numbers of the currently-synced files. If file name is
omitted, list all files synced to this client workspace.

The format is: depot-file#revision - client-file

p4 help integrate

integrate -- Integrate one set of files into another

p4 integrate [options] fromFile[revRange] toFile
p4 integrate [options] -b branch [-r] [toFile[revRange] ...]
p4 integrate [options] -b branch -s fromFile[revRange] [toFile ...]
p4 integrate [options] -S stream [-r] [-P parent] [file[revRange] ...]

options: -c changelist# -d -f -h -i -o -n -m max -t -v
-D<flags> -R<flags>

'p4 integrate' integrates one set of files (the 'source') into
another (the 'target').

(See also 'p4 merge' and 'p4 copy', variants of 'p4 integrate' that
may be easier and more effective for the task at hand.)

Using the client workspace as a staging area, 'p4 integrate' adds and
deletes target files per changes in the source, and schedules all
other affected target files to be resolved. Target files outside of
the current client view are not affected. Source files need not be
within the client view.

'p4 resolve' must be used to merge file content, and to resolve
filename and filetype changes. 'p4 submit' commits integrated files
to the depot. Unresolved files may not be submitted. Integrations
can be shelved with 'p4 shelve' and abandoned with 'p4 revert'. The
commands 'p4 integrated' and 'p4 filelog' display integration history.

When 'p4 integrate' schedules a workspace file to be resolved, it
leaves it read-only. 'p4 resolve' can operate on a read-only file.
For other pre-submit changes, 'p4 edit' must be used to make the
file writable.

Source and target files can be specified either on the 'p4 integrate'
command line or through a branch view. On the command line, fromFile
is the source file set and toFile is the target file set. With a
branch view, one or more toFile arguments can be given to limit the
scope of the target file set.

revRange is a revision or a revision range that limits the span of
source history to be probed for unintegrated revisions. revRange
can be used on fromFile, or on toFile, but not on both. When used on
toFile, it refers to source revisions, not to target revisions. For
details about revision specifiers, see 'p4 help revisions'.

The -S flag makes 'p4 integrate' use a stream's branch view. (See
'p4 help stream'.) The source is the stream itself, and the target is
the stream's parent. With -r, the direction is reversed. -P can be
used to specify a parent stream other than the stream's actual parent.
Note that to submit integrated stream files, the current client must
be dedicated to the target stream. (See 'p4 help client'.)

The -b flag makes 'p4 integrate' use a user-defined branch view.
(See 'p4 help branch'.) The source is the left side of the branch view
and the target is the right side. With -r, the direction is reversed.

The -s flag can be used with -b to cause fromFile to be treated as
the source, and both sides of the branch view to be treated as the
target, per the branch view mapping. Optional toFile arguments may
be given to further restrict the scope of the target file set. The
-r flag is ignored when -s is used.

Note that 'p4 integrate' automatically adusts source-to-target
mappings for moved and renamed files. (Adjustment occurs only if
the 'p4 move' command was used to move/rename files.) The scope of
source and target file sets must include both the old-named and the
new-named files for mappings to be adjusted. Moved source files may
cause target files to be scheduled for filename resolves.

The -f flag forces integrate to ignore integration history and treat
all source revisions as unintegrated. It is meant to be used with
revRange to force reintegration of specific, previously integrated
revisions.

The -i flag enables merging between files that have no prior
integration history. By default, 'p4 integrate' requires a prior
integration in order to identify a base for merging. The -i flag
allows the integration, and schedules the target file to be resolved
using the first source revision as the merge base.

The -o flag causes more merge information to be output. For each
target file scheduled to be resolved, the base file revision and the
source file revision are shown. (After running 'p4 integrate', the
same information is available from 'p4 resolve -o'.)

The -R flags modify the way resolves are scheduled:

-Rb Schedules 'branch resolves' instead of branching new
target files automatically.

-Rd Schedules 'delete resolves' instead of deleting
target files automatically.

-Rs Skips cherry-picked revisions already integrated.
This can improve merge results, but can also cause
multiple resolves per file to be scheduled.

The -D flags modify the way deleted files are treated:

-Dt If the target file has been deleted and the source
file has changed, re-branch the source file on top
of the target file instead of scheduling a resolve.

-Ds If the source file has been deleted and the target
file has changed, delete the target file instead of
scheduling a resolve.

-Di If the source file has been deleted and re-added,
probe revisions that precede the deletion to find
unintegrated revisions. By default, 'p4 integrate'
starts probing at the last re-added revision.

The -d flag is a shorthand for all -D flags used together.

The -h flag leaves the target files at the revision currently synced
to the client (the '#have' revision). By default, target files are
automatically synced to the head revision by 'p4 integrate'.

The -t flag propagates source filetypes instead of scheduling
filetype conflicts to be resolved.

The -m flag limits integration to the first 'max' number of files.

The -n flag displays a preview of integration, without actually
doing anything.

If -c changelist# is specified, the files are opened in the
designated numbered pending changelist instead of the 'default'
changelist.

The -v flag causes a 'virtual' integration that does not modify
client workspace files unless target files need to be resolved.
After submitting a virtual integration, 'p4 sync' can be used to
update the workspace.

p4 help labelsync

labelsync -- Apply the label to the contents of the client workspace

p4 labelsync [-a -d -n -q] -l label [file[revRange] ...]

Labelsync causes the specified label to reflect the current contents
of the client. It records the revision of each file currently synced.
The label's name can subsequently be used in a revision specification
as @label to refer to the revision of a file as stored in the label.

Without a file argument, labelsync causes the label to reflect the
contents of the whole client, by adding, deleting, and updating the
label. If a file is specified, labelsync updates the specified file.

If the file argument includes a revision specification, that revision
is used instead of the revision synced by the client. If the specified
revision is a deleted revision, the label includes that deleted
revision. See 'p4 help revisions' for details about specifying
revisions.

If the file argument includes a revision range specification,
only files selected by the revision range are updated, and the
highest revision in the range is used.

The -a flag adds the specified file to the label.

The -d deletes the specified file from the label, regardless of
revision.

The -n flag previews the operation without altering the label.

Only the owner of a label can run labelsync on that label. A label
that has its Options: field set to 'locked' cannot be updated.

The -q flag suppresses normal output messages. Messages regarding
errors or exceptional conditions are displayed.

p4 help lock

lock -- Lock an open file to prevent it from being submitted

p4 lock [-c changelist#] [file ...]

The specified files are locked in the depot, preventing any user
other than the current user on the current client from submitting
changes to the files. If a file is already locked, the lock request
is rejected. If no file names are specified, all files in the
specified changelist are locked. If changelist number is omitted,
files in the default changelist are locked.

p4 help move

move -- move file(s) from one location to another
rename -- synonym for 'move'

p4 move [-c changelist#] [-f -n -k] [-t filetype] fromFile toFile

Move takes an already opened file and moves it from one client
location to another, reopening it as a pending depot move. When
the file is submitted with 'p4 submit', its depot file is moved
accordingly.

Wildcards in fromFile and toFile must match. The fromFile must be
a file open for add or edit.

'p4 opened' lists pending moves. 'p4 diff' can compare a moved
client file with its depot original, 'p4 sync' can schedule an
update of a moved file, and 'p4 resolve' can resolve the update.

A client file can be moved many times before it is submitted.
Moving a file back to its original location will undo a pending
move, leaving unsubmitted content intact. Using 'p4 revert'
undoes the move and reverts the unsubmitted content.

If -c changelist# is specified, the file is reopened in the
specified pending changelist as well as being moved.

The -f flag forces a move to an existing target file. The file
must be synced and not opened. The originating source file will
no longer be synced to the client.

If -t filetype is specified, the file is assigned that filetype.
If the filetype is a partial filetype, the partial filetype is
combined with the current filetype. See 'p4 help filetypes'.

The -n flag previews the operation without moving files.

The -k flag performs the rename on the server without modifying
client files. Use with caution, as an incorrect move can cause
discrepancies between the state of the client and the corresponding
server metadata.

The 'move' command requires a release 2009.1 or newer client. The
'-f' flag requires a 2010.1 client.

p4 help reopen

reopen -- Change the filetype of an open file or move it to
another changelist

p4 reopen [-c changelist#] [-t filetype] file ...

Reopen an open file for the current user in order to move it to a
different changelist or change its filetype.

The target changelist must exist; you cannot create a changelist by
reopening a file. To move a file to the default changelist, use
'p4 reopen -c default'.

If -t filetype is specified, the file is assigned that filetype. If
a partial filetype is specified, it is combined with the current
filetype. For details, see 'p4 help filetypes'.

Resolve files

The caller must either 1) set an automatic resolution (-as, -am.-af, -at, or -ay), 2) provide a callback function of type to respond to the prompts, or 3) provide a dictionary which contains responses to the prompts.

p4 help resolve

resolve -- Resolve integrations and updates to workspace files

p4 resolve [options] [file ...]

options: -A<flags> -a<flags> -d<flags> -f -n -N -o -t -v
-c changelist#

'p4 resolve' resolves changes to files in the client workspace.

'p4 resolve' works only on files that have been scheduled to be
resolved. The commands that can schedule resolves are: 'p4 sync',
'p4 update', 'p4 submit', 'p4 merge', and 'p4 integrate'. Files must
be resolved before they can be submitted.

Resolving involves two sets of files, a source and a target. The
target is a set of depot files that maps to opened files in the
client workspace. When resolving an integration, the source is a
different set of depot files than the target. When resolving an
update, the source is the same set of depot files as the target,
at a different revision.

The 'p4 resolve' file argument specifies the target. If the file
argument is omitted, all unresolved files are resolved.

Resolving can modify workspace files. To back up files, use 'p4
shelve' before using 'p4 resolve'.

The resolve process is a classic three-way merge. The participating
files are referred to as follows:

'yours' The target file open in the client workspace
'theirs' The source file in the depot
'base' The common ancestor; the highest revision of the
source file already accounted for in the target.
'merged' The merged result.

Filenames, filetypes, and text file content can be resolved by
accepting 'yours', 'theirs', or 'merged'. Branching, deletion, and
binary file content can be resolved by accepting either 'yours' or
'theirs'.

When resolving integrated changes, 'p4 resolve' distinguishes among
four results: entirely yours, entirely theirs, a pure merge, or an
edited merge. The distinction is recorded when resolved files are
submitted, and will be used by future commands to determine whether
integration is needed.

In all cases, accepting 'yours' leaves the target file in its current
state. The result of accepting 'theirs' is as follows:

Content: The target file content is overwritten.
Branching: A new target is branched.
Deletion: The target file is deleted.
Filename: The target file is moved or renamed.
Filetype: The target file's type is changed.

For each unresolved change, the user is prompted to accept a result.
Content and non-content changes are resolved separately. For content,
'p4 resolve' places the merged result into a temporary file in the
client workspace. If there are any conflicts, the merged file contains
conflict markers that must be removed by the user.

'p4 resolve' displays a count of text diffs and conflicts, and offers
the following prompts:

Accept:
at Keep only changes to their file.
ay Keep only changes to your file.
* am Keep merged file.
* ae Keep merged and edited file.
* a Keep autoselected file.

Diff:
* dt See their changes alone.
* dy See your changes alone.
* dm See merged changes.
d Diff your file against merged file.

Edit:
et Edit their file (read only).
ey Edit your file (read/write).
* e Edit merged file (read/write).

Misc:
* m Run '$P4MERGE base theirs yours merged'.
(Runs '$P4MERGEUNICODE charset base theirs
yours merged' if set and the file is a
unicode file.)
s Skip this file.
h Print this help message.
^C Quit the resolve operation.

Options marked (*) appear only for text files. The suggested action
will be displayed in brackets.

The 'merge' (m) option enables you to invoke your own merge program, if
one is configured using the $P4MERGE environment variable. Four files
are passed to the program: the base, yours, theirs, and the temporary
file. The program is expected to write merge results to the temporary
file.

The -A flag can be used to limit the kind of resolving that will be
attempted; without it, everything is attempted:

-Ab Resolve file branching.
-Ac Resolve file content changes.
-Ad Resolve file deletions.
-Am Resolve moved and renamed files.
-At Resolve filetype changes.

The -a flag puts 'p4 resolve' into automatic mode. The user is not
prompted, and files that can't be resolved automatically are skipped:

-as 'Safe' resolve; skip files that need merging.
-am Resolve by merging; skip files with conflicts.
-af Force acceptance of merged files with conflicts.
-at Force acceptance of theirs; overwrites yours.
-ay Force acceptance of yours; ignores theirs.

The -as flag causes the workspace file to be replaced with their file
only if theirs has changed and yours has not.

The -am flag causes the workspace file to be replaced with the result
of merging theirs with yours. If the merge detected conflicts, the
file is left untouched and uresolved.

The -af flag causes the workspace file to be replaced with the result
of merging theirs with yours, even if there were conflicts. This can
leave conflict markers in workspace files.

The -at flag resolves all files by copying theirs into yours. It
should be used with care, as it overwrites any changes made to the
file in the client workspace.

The -ay flag resolves all files by accepting yours and ignoring
theirs. It preserves the content of workspace files.

The -d flags can be used to control handling of whitespace and line
endings when merging files:

-db Ingore whitespace changes.
-dw Ingore whitespace altogether.
-dl Ignores line endings.

The -d flags are also passed to the diff options in the 'p4 resolve'
dialog. Additional -d flags that modify the diff output but do not
modify merge behavior include -dn (RCS), -dc (context), -ds (summary),
and -du (unified). Note that 'p4 resolve' uses text from the client
file if the files differ only in whitespace.

The -f flag enables previously resolved content to be resolved again.
By default, after files have been resolved, 'p4 resolve' does not
process them again.

The -n flag previews the operation without altering files.

The -N flag previews the operation with additional information about
any non-content resolve actions that are scheduled.

The -o flag displays the base file name and revision to be used
during the the merge.

The -t flag forces 'p4 resolve' to attempt a textual merge, even for
files with non-text (binary) types.

The -v flag causes 'p4 resolve' to insert markers for all changes,
not just conflicts.

The -c flag limits 'p4 resolve' to the files in changelist#.

p4 help submit

submit -- Submit open files to the depot

p4 submit [-r -s -f option]
p4 submit [-r -s -f option] file
p4 submit [-r -f option] -d description
p4 submit [-r -f option] -d description file
p4 submit [-r -f option] -c changelist#
p4 submit -i [-r -s -f option]

'p4 submit' commits a pending changelist and its files to the depot.

By default, 'p4 submit' attempts to submit all files in the 'default'
changelist. Submit displays a dialog where you enter a description
of the change and, optionally, delete files from the list of files
to be checked in.

To add files to a changelist before submitting, use any of the
commands that open client workspace files: 'p4 add', 'p4 edit',
etc.

If the file parameter is specified, only files in the default
changelist that match the pattern are submitted.

Files in a stream path can be submitted only by client workspaces
dedicated to the stream. See 'p4 help client'.

Before committing a changelist, 'p4 submit' locks all the files being
submitted. If any file cannot be locked or submitted, the files are
left open in a numbered pending changelist. 'p4 opened' shows
unsubmitted files and their changelists.

Submit is atomic: if the operation succeeds, all files are updated
in the depot. If the submit fails, no depot files are updated.

The -c flag submits the specified pending changelist instead of the
default changelist. Additional changelists can be created manually,
using the 'p4 change' command, or automatically as the result of a
failed attempt to submit the default changelist.

The -d flag passes a description into the specified changelist rather
than displaying the changelist dialog for manual editing. This option
is useful for scripting, but does not allow you to add jobs or modify
the default changelist.

The -f flag enables you to override submit options that are configured
for the client that is submitting the changelist. This flag overrides
the -r (reopen)flag, if it is specified. See 'p4 help client' for
details about submit options.

The -i flag reads a changelist specification from the standard input.
The user's editor is not invoked.

The -r flag reopens submitted files in the default changelist after
submission.

The -s flag extends the list of jobs to include the fix status
for each job, which becomes the job's status when the changelist
is committed. See 'p4 help change' for details.

p4 help resolved

resolved -- Show files that have been resolved but not submitted

p4 resolved [-o] [file ...]

'p4 resolved' lists file updates and integrations that have been
resolved but not yet submitted. To see unresolved integrations,
use 'p4 resolve -n'. To see already submitted integrations, use
'p4 integrated'.

If a depot file path is specified, the output lists resolves for
'theirs' files that match the specified path. If a client file
path is specified, the output lists resolves for 'yours' files
that match the specified path.

The -o flag reports the revision used as the base during the
resolve.

RevertFilesOptions
p4 help revert

revert -- Discard changes from an opened file

p4 revert [-a -n -k -c changelist#] file ...

Revert an open file to the revision that was synced from the depot,
discarding any edits or integrations that have been made. You must
explicitly specify the files to be reverted. Files are removed from
the changelist in which they are open. Locked files are unlocked.

The -a flag reverts only files that are open for edit or integrate
and are unchanged or missing. Files with pending integration records
are left open. The file arguments are optional when -a is specified.

The -n flag displays a preview of the operation.

The -k flag marks the file as reverted in server metadata without
altering files in the client workspace.

The -c flag reverts files that are open in the specified changelist.

p4 help shelve

shelve -- Store files from a pending changelist into the depot

p4 shelve [files]
p4 shelve -i [-f | -r]
p4 shelve -r -c changelist#
p4 shelve -c changelist# [-f] [file ...]
p4 shelve -d -c changelist# [-f] [file ...]

'p4 shelve' creates, modifies or deletes shelved files in a pending
changelist. Shelved files remain in the depot until they are deleted
(using 'p4 shelve -d') or replaced by subsequent shelve commands.
After 'p4 shelve', the user can revert the files and restore them
later using 'p4 unshelve'. Other users can 'p4 unshelve' the stored
files into their own workspaces.

Files that have been shelved can be accessed by the 'p4 diff',
'p4 diff2', 'p4 files' and 'p4 print' commands using the revision
specification '@=change', where 'change' is the pending changelist
number.

By default, 'p4 shelve' creates a changelist, adds files from the
user's default changelist, then shelves those files in the depot.
The user is presented with a text changelist form displayed using
the editor configured using the $P4EDITOR environment variable.

If a file pattern is specified, 'p4 shelve' shelves the files that
match the pattern.

The -i flag reads the pending changelist specification with shelved
files from the standard input. The user's editor is not invoked.
To modify an existing changelist with shelved files, specify the
changelist number using the -c flag.

The -c flag specifies the pending changelist that contains shelved
files to be created, deleted, or modified. Only the user and client
of the pending changelist can add or modify its shelved files.

The -f (force) flag must be used with the -c or -i flag to overwrite
any existing shelved files in a pending changelist.

The -r flag (used with -c or -i) enables you to replace all shelved
files in that changelist with the files opened in your own workspace
at that changelist number. Only the user and client workspace of the
pending changelist can replace its shelved files.

The -d flag (used with -c) deletes the shelved files in the specified
changelist so that they can no longer be unshelved. By default, only
the user and client of the pending changelist can delete its shelved
files. A user with 'admin' access can delete shelved files by including
the -f flag to force the operation.

p4 help sync

sync -- Synchronize the client with its view of the depot
flush -- synonym for 'sync -k'
update -- synonym for 'sync -s'

p4 sync [-f -L -n -k -q] [-m max] [file[revRange] ...]
p4 sync [-L -n -q -s] [-m max] [file[revRange] ...]
p4 sync [-L -n -p -q] [-m max] [file[revRange] ...]

Sync updates the client workspace to reflect its current view (if
it has changed) and the current contents of the depot (if it has
changed). The client view maps client and depot file names and
locations.

Sync adds files that are in the client view and have not been
retrieved before. Sync deletes previously retrieved files that
are no longer in the client view or have been deleted from the
depot. Sync updates files that are still in the client view and
have been updated in the depot.

By default, sync affects all files in the client workspace. If file
arguments are given, sync limits its operation to those files.
The file arguments can contain wildcards.

If the file argument includes a revision specifier, then the given
revision is retrieved. Normally, the head revision is retrieved.
See 'p4 help revisions' for help specifying revisions.

If the file argument includes a revision range specification,
only files selected by the revision range are updated, and the
highest revision in the range is used.

Normally, sync does not overwrite workspace files that the user has
manually made writable. Setting the 'clobber' option in the
client specification disables this safety check.

The -f flag forces resynchronization even if the client already
has the file, and overwriting any writable files. This flag doesn't
affect open files.

The -L flag can be used with multiple file arguments that are in
full depot syntax and include a valid revision number. When this
flag is used the arguments are processed together by building an
internal table similar to a label. This file list processing is
significantly faster than having to call the internal query engine
for each individual file argument. However, the file argument syntax
is strict and the command will not run if an error is encountered.

The -n flag previews the operation without updating the workspace.

The -k flag updates server metadata without syncing files. It is
intended to enable you to ensure that the server correctly reflects
the state of files in the workspace while avoiding a large data
transfer. Caution: an erroneous update can cause the server to
incorrectly reflect the state of the workspace.

The -p flag populates the client workspace, but does not update the
server to reflect those updates. Any file that is already synced or
opened will be bypassed with a warning message. This option is very
useful for build clients or when publishing content without the
need to track the state of the client workspace.

The -q flag suppresses normal output messages. Messages regarding
errors or exceptional conditions are not suppressed.

The -s flag adds a safety check before sending content to the client
workspace. This check uses MD5 digests to compare the content on the
clients workspace against content that was last synced. If the file
has been modified outside of Perforce's control then an error message
is displayed and the file is not overwritten. This check adds some
extra processing which will affect the performance of the operation.

The -m flag limits sync to the first 'max' number of files. This
option is useful in conjunction with tagged output and the '-n'
flag, to preview how many files will be synced without transferring
all the file data.

p4 help unlock

unlock -- Release a locked file, leaving it open

p4 unlock [-c changelist#] [-f] [file ...]

'p4 unlock' releases locks on the specified files, which must be
open in the specified pending changelist. If you omit the changelist
number, the default changelist is assumed. If you omit the file name,
all locked files are unlocked.

By default, files can be unlocked only by the changelist owner. The
-f flag enables you to unlock files in changelists owned by other
users. The -f flag requires 'admin' access, which is granted by 'p4
protect'.

p4 help unshelve

unshelve -- Restore shelved files from a pending change into a workspace

p4 unshelve -s changelist# [-f -n] [-c changelist#] [file ...]

'p4 unshelve' retrieves shelved files from the specified pending
changelist, opens them in a pending changelist and copies them
to the invoking user's workspace. Unshelving files from a pending
changelist is restricted by the user's permissions on the files.
A successful unshelve operation places the shelved files on the
user's workspace with the same open action and pending integration
history as if it had originated from that user and client.

Unshelving a file over an already opened file is only permitted
if both shelved file and opened file are opened for 'edit'. After
unshelving, the workspace file is flagged as unresolved, and
'p4 resolve' must be run to resolve the differences between the
shelved file and the workspace file.

The -s flag specifies the number of the pending changelist that
contains the shelved files.

If a file pattern is specified, 'p4 unshelve' unshelves files that
match the pattern.

The -c flag specifies the changelist to which files are unshelved.
By default, 'p4 unshelve' opens shelved files in the default
changelist.

The -f flag forces the clobbering of any writeable but unopened files
that are being unshelved.

The -n flag previews the operation without changing any files or
metadata.

p4 help where

where -- Show how file names are mapped by the client view

p4 where [file ...]

Where shows how the specified files are mapped by the client view.
For each argument, three names are produced: the name in the depot,
the name on the client in Perforce syntax, and the name on the client
in local syntax.

If the file parameter is omitted, the mapping for all files in the
current directory and below) is returned.

Note that 'p4 where' does not determine where any real files reside.
It only displays the locations that are mapped by the client view.

p4 help copy

copy -- Copy one set of files to another

p4 copy [options] fromFile[rev] toFile
p4 copy [options] -b branch [-r] [toFile[rev] ...]
p4 copy [options] -b branch -s fromFile[rev] [toFile ...]
p4 copy [options] -S stream [-P parent] [-F] [-r] [toFile[rev] ...]

options: -c changelist# -n -v -m max

'p4 copy' copies one set of files (the 'source') into another (the
'target').

Using the client workspace as a staging area, 'p4 copy' makes the
target identical to the source by branching, replacing, or deleting
files. 'p4 submit' submits copied files to the depot. 'p4 revert'
can be used to revert copied files instead of submitting them. The
history of copied files can be shown with 'p4 filelog' or 'p4
integrated'.

Target files that are already identical to the source, or that are
outside of the client view, are not affected by 'p4 copy'. Opened,
non-identical target files cause 'p4 copy' to exit with a warning.
When 'p4 copy' creates or modifies files in the workspace, it leaves
them read-only; 'p4 edit' can make them writable. Files opened by
'p4 copy' do not need to be resolved.

Source and target files (fromFile and toFile) can be specified on
the 'p4 copy' command line or through a branch view. On the command
line, fromFile is the source file set and toFile is the target file
set. With a branch view, one or more toFile arguments can be given
to limit the scope of the target file set.

A revision specifier can be used to select the revision to copy; by
default, the head revision is copied. The revision specifier can be
used on fromFile, or on toFile, but not on both. When used on toFile,
it refers to source revisions, not to target revisions. A range may
not be used as a revision specifier. For revision syntax, see 'p4
help revisions'.

The -S flag makes 'p4 copy' use a stream's branch view. (See 'p4 help
stream'.) The source is the stream itself, and the target is the
stream's parent. With -r, the direction is reversed. -P can be used
to specify a parent stream other than the stream's actual parent.
Note that to submit copied stream files, the current client must
be dedicated to the target stream. (See 'p4 help client'.)

The -F flag can be used with -S to force copying even though the
stream does not expect a copy to occur in the direction indicated.
Normally 'p4 copy' enforces the expected flow of change dictated
by the stream's spec. The 'p4 istat' command summarizes a stream's
expected flow of change.

The -b flag makes 'p4 copy' use a user-defined branch view. (See
'p4 help branch'.) The source is the left side of the branch view
and the target is the right side. With -r, the direction is reversed.

The -s flag can be used with -b to cause fromFile to be treated as
the source, and both sides of the user-defined branch view to be
treated as the target, per the branch view mapping. Optional toFile
arguments may be given to further restrict the scope of the target
file set. -r is ignored when -s is used.

The -c changelist# flag opens files in the designated (numbered)
pending changelist instead of the default changelist.

The -n flag displays a preview of the copy, without actually doing
anything.

The -m flag limits the actions to the first 'max' number of files.

The -v flag causes a 'virtual' copy that does not modify client
workspace files. After submitting a virtual integration, 'p4 sync'
can be used to update the workspace.

p4 help merge

merge -- Merge one set of files into another

p4 merge [options] fromFile[revRange] toFile
p4 merge [options] -b branch [-r] [toFile[revRange] ...]
p4 merge [options] -b branch -s fromFile[revRange] [toFile ...]
p4 merge [options] -S stream [-P parent] [-F] [-r] [toFile[revRange] ...]

options: -c changelist# -n -m max

'p4 merge' merges changes from one set of files (the 'source') into
another (the 'target'). It is a simplified form of the 'p4 integrate'
command.

Using the client workspace as a staging area, 'p4 merge' branches and
deletes target files per changes in the source, and schedules all
other affected target files to be resolved. Target files outside of
the current client view are not affected. Source files need not be
within the client view.

'p4 resolve' must be used to merge file content, and to resolve
filename and filetype changes. 'p4 submit' commits merged files to
the depot. Unresolved files may not be submitted. Merged files can
be shelved with 'p4 shelve' and abandoned with 'p4 revert'. The
commands 'p4 integrated' and 'p4 filelog' display merge history.

When 'p4 merge' schedules a workspace file to be resolved, it leaves
it read-only. 'p4 resolve' can operate on a read-only file; for
other pre-submit changes, 'p4 edit' must be used to make the file
writable.

Source and target files can be specified either on the 'p4 merge'
command line or through a branch view. On the command line, fromFile
is the source file set and toFile is the target file set. With a
branch view, one or more toFile arguments can be given to limit the
scope of the target file set.

Each file in the target is mapped to a file in the source. Mapping
adjusts automatically for files that have been moved or renamed, as
long as 'p4 move' was used to move/rename files. The scope of source
and target file sets must include both old-named and new-named files
for mappings to be adjusted. Moved source files may schedule moves
to be resolved in target files.

revRange is a revision or a revision range that limits the span of
source history to be probed for unintegrated revisions. revRange
can be used on fromFile, or on toFile, but not on both. When used
on toFile, it refers to source revisions, not to target revisions.
For details about revision specifiers, see 'p4 help revisions'.

The -S flag makes 'p4 merge' use a stream's branch view. (See 'p4
help stream'.) The source is the stream itself, and the target is
the stream's parent. With -r, the direction is reversed. -P can be
used to specify a parent stream other than the stream's actual parent.
Note that to submit merged stream files, the current client must
be dedicated to the target stream. (See 'p4 help client'.)

The -F flag can be used with -S to force merging even though the
stream does not expect a merge to occur in the direction indicated.
Normally 'p4 merge' enforces the expected flow of change dictated
by the stream's spec. The 'p4 istat' command summarizes a stream's
expected flow of change.

The -b flag makes 'p4 merge' use a user-defined branch view. (See
'p4 help branch'.) The source is the left side of the branch view
and the target is the right side. With -r, the direction is reversed.

The -s flag can be used with -b to cause fromFile to be treated as
the source, and both sides of the branch view to be treated as the
target, per the branch view mapping. Optional toFile arguments may
be given to further restrict the scope of the target file set. The
-r flag is ignored when -s is used.

Metadata from the client associated with a connection.

Read the fields from the tagged output of an info command

Tagged output from the 'info' command

Flags for the server connection status.

Disconnected from server.

Connected to server.

Represents the logical connection between a specific Perforce Server instance and a specific client application.

Run a Login on the Perforce Server

User' password Login options (see remarks in help file) Login as user (see remarks in help file) Success/Failure
p4 help login

login -- Log in to Perforce by obtaining a session ticket

p4 login [-a -p] [-h <host> user]
p4 login [-s]

The login command enables a user to access Perforce until the session
expires or the user logs out.

When a user logs in to Perforce, they are prompted for a password
If they enter the correct password, they are issued a ticket. The
ticket expires when the default timeout value has been reached and
is valid only for the host machine where the 'login' command was
executed (see below for exception).

The ticket can be used anywhere that a password can be used.

Example: p4 -P <ticket value> changes -m1

The -a flag causes the server to issue a ticket that is valid on all
host machines.

The -h flag causes the server to issue a ticket that is valid on the
specified host (IP address). This flag can only be used when the
login request is for another user.

The -p flag displays the ticket, but does not store it on the client
machine.

The -s flag displays the status of the current ticket (if there is
one).

Specifying a username as an argument to 'p4 login' requires 'super'
access, which is granted by 'p4 protect'. In this case, 'p4 login'
does not prompt for the password (you must already be logged in).

User' password Login options (see remarks in help file) Success/Failure
p4 help login

login -- Log in to Perforce by obtaining a session ticket

p4 login [-a -p] [-h <host> user]
p4 login [-s]

The login command enables a user to access Perforce until the session
expires or the user logs out.

When a user logs in to Perforce, they are prompted for a password
If they enter the correct password, they are issued a ticket. The
ticket expires when the default timeout value has been reached and
is valid only for the host machine where the 'login' command was
executed (see below for exception).

The ticket can be used anywhere that a password can be used.

Example: p4 -P <ticket value> changes -m1

The -a flag causes the server to issue a ticket that is valid on all
host machines.

The -h flag causes the server to issue a ticket that is valid on the
specified host (IP address). This flag can only be used when the
login request is for another user.

The -p flag displays the ticket, but does not store it on the client
machine.

The -s flag displays the status of the current ticket (if there is
one).

Specifying a username as an argument to 'p4 login' requires 'super'
access, which is granted by 'p4 protect'. In this case, 'p4 login'
does not prompt for the password (you must already be logged in).

Automate the Login to the Perforce Server

User' password Login options (see remarks in help file) Login as user (see remarks in help file) Success/Failure Runs the login process. If the server is using ticket based authentication, actually runs the logn three times. Once to login and update the ticket file, once to get the ticket from the server and finally once to get the ticket expiration data.

Logout of the Perforce server

Logout options (see remarks in help file) Success/Failure
p4 help logout

logout -- Log out from Perforce by removing or invalidating a ticket.

p4 logout [-a]

The logout command removes the ticket on the client. To resume using
Perforce, the user must log in again.

The -a flag invalidates the ticket on the server, which will log out
all users of the ticket.

Run the client side command trust

trust options (see remarks in help file) Success/Failure
p4 trust -h

trust -- Establish trust of an SSL connection

p4 trust [ -l -y -n -d -f -r -i <fingerprint> ]

Establish trust of an SSL connection. This client command manages
the p4 trust file. This file contains fingerprints of the keys
received on ssl connections. When an SSL connection is made, this
file is examined to determine if the SSL connection has been used
before and if the key is the same as a previously seen key for that
connection. Establishing trust with a connection prevents undetected
communication interception (man-in-the-middle) attacks.

Most options are mutually exclusive. Only the -r and -f options
can be combined with the others.

The -l flag lists existing known fingerprints.

Without options, this command will make a connection to a server
and examine the key if present, if one cannot be found this command
will show a fingerprint and ask if this connection should be trusted.
If a fingerprint exists and does not match, an error that a possible
security problems exists will be displayed.

The -y flag will cause prompts to be automatically accepted.

The -n flag will cause prompts to be automatically refused.

The -d flag will remove an existing trusted fingerprint of a connection.

The -f flag will force the replacement of a mismatched fingerprint.

The -i flag will allow a specific fingerprint to be installed.

The -r flag specifies that a replacement fingerprint is to be
affected. Replacement fingerprints can be used in anticipation
of a server replacing its key. If a replacement fingerprint
exists for a connection and the primary fingerprint does not match
while the replacement fnigerprint does, the replacement fingerprint
will replace the primary. This flag can be combined with -l, -i,
or -d.

Set the current user's password on the Perforce server.

User's old password User's new password Success/Failure
p4 help passwd

passwd -- Set the user's password on the server (and Windows client)

p4 passwd [-O oldPassword -P newPassword] [user]

'p4 passwd' sets the user's password on the server.

After a password is set for a user, the same password must be set on
the client in the environment variable $P4PASSWD to enable the user
to use all Perforce client applications on that machine. (On Windows,
you can use 'p4 passwd' to configure the password in the environment.)

'p4 passwd' prompts for both the old password and the new password
with character echoing turned off. To delete the password, set it to
an empty string.

The -O flag provides the old password, avoiding prompting.

The -P flag provides the new password, avoiding prompting.

If you are using ticket-based authentication, changing your password
automatically invalidates all of your tickets and logs you out.

Specifying a username as an argument to 'p4 passwd' requires 'super'
access granted by 'p4 protect'.

Set the a user's password on the Perforce server.

User's old password User's new password User receiving new password Success/Failure
p4 help passwd

passwd -- Set the user's password on the server (and Windows client)

p4 passwd [-O oldPassword -P newPassword] [user]

'p4 passwd' sets the user's password on the server.

After a password is set for a user, the same password must be set on
the client in the environment variable $P4PASSWD to enable the user
to use all Perforce client applications on that machine. (On Windows,
you can use 'p4 passwd' to configure the password in the environment.)

'p4 passwd' prompts for both the old password and the new password
with character echoing turned off. To delete the password, set it to
an empty string.

The -O flag provides the old password, avoiding prompting.

The -P flag provides the new password, avoiding prompting.

If you are using ticket-based authentication, changing your password
automatically invalidates all of your tickets and logs you out.

Specifying a username as an argument to 'p4 passwd' requires 'super'
access granted by 'p4 protect'.

Create a P4Command that can be run on the connection

Command name, i.e. 'sync' Flag to create tggged output The arguments for the command

Create a P4.P4MapApi object to be used on the current server connection

What API level does the server support

The errors (if any) of the command execution

The results of the last command executed

Specifies user credentials for a specific connection.

The type of the depot.

A 'local' depot (the default) is managed directly by the server and its files reside in the server's root directory.

A 'remote' depot refers to files in another Perforce server.

A 'spec' depot automatically archives all edited forms (branch, change, client, depot, group, job, jobspec, protect, triggers, typemap, and user) in special, read-only files. The files are named: //depotname/formtype/name[suffix]. Updates to jobs made by the 'p4 change', 'p4 fix', and 'p4 submit' commands are also saved, but other automatic updates such as as access times or opened files (for changes) are not. A server can contain only one 'spec' depot.

A 'stream' depot is a local depot dedicated to the storage of files in a stream.

An 'archive' depot defines a storage location to which obsolete revisions may be relocated.

p4 help depot

depot -- Create or edit a depot specification

p4 depot name
p4 depot -d name
p4 depot -o name
p4 depot -i

Create a new depot specification or edit an existing depot
specification. The specification form is put into a temporary file
and the editor (configured by the environment variable $P4EDITOR)
is invoked.

The depot specification contains the following fields:

Depot: The name of the depot. This name cannot be the same as
any branch, client, or label name.

Owner: The user who created this depot.

Date: The date that this specification was last modified.

Description: A short description of the depot (optional).

Type: 'local', 'stream', 'remote', 'spec', or 'archive'.

A 'local' depot (the default) is managed directly by
the server and its files reside in the server's root
directory.

A 'stream' depot is a local depot dedicated to the
storage of files in a stream.

A 'remote' depot refers to files in another Perforce
server.

A 'spec' depot automatically archives all edited forms
(branch, change, client, depot, group, job, jobspec,
protect, triggers, typemap, and user) in special,
read-only files. The files are named:
//depotname/formtype/name[suffix]. Updates to jobs made
by the 'p4 change', 'p4 fix', and 'p4 submit' commands
are also saved, but other automatic updates such as
as access times or opened files (for changes) are not.
A server can contain only one 'spec' depot.

A 'archive' depot defines a storage location to which
obsolete revisions may be relocated.

Address: For remote depots, the $P4PORT (connection address)
of the remote server.

Suffix: For spec depots, the optional suffix to be used
for generated paths. The default is '.p4s'.

Map: Path translation information, in the form of a file
pattern with a single ... in it. For local depots,
this path is relative to the server's root directory
(Example: depot/...). For remote depots, this path
refers to the remote server's namespace
(Example: //depot/...).

The -d flag deletes the specified depot. If any files reside in the
depot, they must be removed with 'p4 obliterate' before deleting the
depot.

The -o flag writes the depot specification to standard output. The
user's editor is not invoked.

The -i flag reads a depot specification from standard input. The
user's editor is not invoked.

A depot specification in a Perforce repository.

Read the fields from the tagged output of a depot command

Tagged output from the 'depot' command

Parse the fields from a depot specification

Text of the depot specification in server format

Format of a depot specification used to save a depot to the server

Convert to specification in server format

Read the fields from the tagged output of a depots command

Tagged output from the 'depots' command

The types of diffs returned by the server.

File contents are different.

File contents are identical but file types are different.

The left file in the diff has no target file at the specified name or revision to pair with for a diff.

The right file in the diff has no source file at the specified name or revision to pair with for a diff.

File content and file types are identical.

p4 help diff2

diff2 -- Compare one set of depot files to another

p4 diff2 [options] fromFile[rev] toFile[rev]
p4 diff2 [options] -b branch [[fromFile[rev]] toFile[rev]]
p4 diff2 [options] -S stream [-P parent] [[fromFile[rev]] toFile[rev]]

options: -d<flags> -q -t -u

'p4 diff2' runs on the server to compare one set of depot files (the
'source') to another (the 'target'). Source and target file sets
can be specified on the 'p4 diff2' command line or through a branch
view.

With a branch view, fromFile and toFile are optional; fromFile limits
the scope of the source file set, and toFile limits the scope of the
target. If only one file argument is given, it is assumed to be
toFile.

fromFile and toFile can include revision specifiers; by default, the
head revisions are diffed. See 'p4 help revisions' for details
about specifying file revisions.

'p4 diff2' precedes each diffed file pair with a header line of the
following form:

==== source#rev (type) - target#rev (type) ==== summary

A source or target file shown as '<none>' means there is no file
at the specified name or revision to pair with its counterpart.
The summary status is one of the following: 'identical' means file
contents and types are identical, 'types' means file contents are
identical but the types are different, and 'content' means file
contents are different.

The -b flag makes 'p4 diff2' use a user-defined branch view. (See
'p4 help branch'.) The left side of the branch view is the source
and the right side is the target.

The -S flag makes 'p4 diff2' use a stream's branch view. (See 'p4
help stream'.) The stream is the source, and its parent is the
target. -P can be used to specify a parent stream other than the
stream's actual parent.

The -d<flags> modify the output of diffs as follows:

-dn (RCS)
-dc[n] (context)
-ds (summary)
-du[n] (unified)
-db (ignore whitespace changes)
-dw (ignore whitespace)
-dl (ignore line endings).

The optional argument to -dc specifies number of context lines.

The -q omits files that have identical content and types and
suppresses the actual diff for all files.

The -t flag forces 'p4 diff2' to diff binary files.

The -u flag uses the GNU diff -u format and displays only files
that differ. The file names and dates are in Perforce syntax, but
but the output can be used by the patch program.

A diff between depot files in a Perforce repository.

Read the fields from the tagged output of a diff2 command

Tagged output from the 'diff2' command

A user group on a Perforce Server, represented by a P4 Group spec.

p4 help group

group -- Change members of user group

p4 group [-a] name
p4 group -d [-a] name
p4 group -o name
p4 group -i [-a]

Create a group or modify the membership of an existing group.
A group can contain users and other groups. The group specification
is put into a temporary file and the editor (configured by the
environment variable $P4EDITOR) is invoked.

A group exists when it has any users or other groups in it, and
ceases to exist if all users and groups in it are removed.

Each group has MaxResults, MaxScanRows, and MaxLockTime fields,
which limit the resources committed to operations performed by
members of the group. For these fields, 'unlimited' or 'unset'
means no limit for that group. An individual user's limit is the
highest of any group with a limit to which he belongs, unlimited if
any of his groups has 'unlimited' for that field, or unlimited
if he belongs to no group with a limit. See 'p4 help maxresults'
for more information on MaxResults, MaxScanRows and MaxLockTime.

Each group also has a Timeout field, which specifies how long (in
seconds) a 'p4 login' ticket remains valid. A value of 'unset' or
'unlimited' is equivalent to no timeout. An individual's timeout is
the highest of any group with a limit to which he belongs, unlimited
if any of his groups has 'unlimited' for the timeout value, or
unlimited if he belongs to no group with a limit. See 'p4 help login'
for more information.

Each group has a PasswordTimeout field, which determines how long a
password remains valid for members of the group.

The -d flag deletes a group.

The -o flag writes the group specification to standard output. The
user's editor is not invoked.

The -i flag reads a group specification from standard input. The
user's editor is not invoked. The new group specification replaces
the previous one.

The -a flag enables a user without 'super' access to modify the group
if that user is an 'owner' of that group. Group owners are specified
in the 'Owners' field of the group spec.

All commands that require access granted by 'p4 protect' consider a
user's groups when calculating access levels.

'p4 group' requires 'super' access granted by 'p4 protect' unless
invoked with the '-a' flag by a qualified user.

A group specification in a Perforce repository.

Create a group supplying the name.

Create a group providing all of the properties

Read the fields from the tagged output of a group command

Tagged output from the 'user' command

Parse the fields from a group specification

Text of group user specification in server format # A Perforce Group Specification. # # Group: The name of the group. # MaxResults: Limits the rows (unless 'unlimited' or 'unset') any one # operation can return to the client. # See 'p4 help maxresults'. # MaxScanRows: Limits the rows (unless 'unlimited' or 'unset') any one # operation can scan from any one database table. # See 'p4 help maxresults'. # MaxLockTime: Limits the time (in milliseconds, unless 'unlimited' or # 'unset') any one operation can lock any database table when # scanning data. See 'p4 help maxresults'. # Timeout: A time (in seconds, unless 'unlimited' or 'unset') # which determines how long a 'p4 login' # session ticket remains valid (default is 12 hours). # PasswordTimeout: # A time (in seconds, unless 'unlimited' or 'unset') # which determines how long a 'p4 password' # password remains valid (default is unset). # Subgroups: Other groups automatically included in this group. # Owners: Users allowed to change this group without requiring super # access permission. # Users: The users in the group. One per line.

Format of a user specification used to save a user to the server

Convert to specification in server format

The specification for the group

The name of the group.

Limits the rows (unless 'unlimited' or 'unset') any one operation can return to the client.

Limits the rows (unless 'unlimited' or 'unset') any one operation can scan from any one database table.

Limits the time (in milliseconds, unless 'unlimited' or 'unset') any one operation can lock any database table when scanning data.

A time (in seconds, unless 'unlimited' or 'unset') which determines how long a 'p4 login' session ticket remains valid (default is 12 hours).

A time (in seconds, unless 'unlimited' or 'unset') which determines how long a 'p4 password' password remains valid (default is unset).

Users allowed to change this group without requiring super access permission.

The users in the group.

Other groups automatically included in this group.

A general-purpose counter or named variable in a Perforce repository.

A versioned object that describes an individual file in a Perforce repository.

Identifies one or more specific versioned objects in a Perforce repository.

Create a list of FileSpec objects from a list of client paths

List of paths List of FileSpec objects

Create a list of FileSpec objects from a list of depot paths

List of paths List of FileSpec objects

Create a list of FileSpec objects from a list of local paths

List of paths List of FileSpec objects

Create a list of FileSpec objects from a list of local paths

List of paths List of FileSpec objects

Create an array of FileSpec objects from a list of local paths

List of paths List of FileSpec objects

Create an array of FileSpec objects from a list of local paths

List of paths List of FileSpec objects

Copy the non-null entries into a new string array.

Copy the non-null entries into a new string array with the paths escaped for special characters

Copy the non-null entries into a new string array.

Copy the non-null entries into a new string array containing the paths.

Copy the non-null entries into a new string array containing the paths escaped for special characters

Copy the non-null entries into a new string array containing the local paths escaped for special characters

Correlates file lines with revision information.

Describes a Perforce file revision in detail, including the changelist number and associated description, action, user, etc. data.

Convert to a string of the format ... #{rev} change {change} {action} on {date} {user}@{client} (type) '{desc}'

Convert to a string of the format ... #{rev} change {change} {action} on {date}[ {time}] {user}@{client} (type) '{desc}'

Include the time as well as the date

Describes an integration, specifying the from file and how the integration was done.

Represents submitted or pending integrations.

Specifies whether this line match is an exact match, or a context (before or after) match.

Specifies matching lines in Perforce managed files.

Describes the pending or completed action related to open, resolve, or integration for a specific file.

None.

Opened for add.

Opened for branch.

Opened for edit.

Opened for integrate.

File has been deleted.

file was integrated from partner-file, and partner-file had been previously deleted.

file was integrated into partner-file, and file had been previously deleted.

File has been synced.

File has been updated.

File has been added.

file was integrated into previously nonexistent partner-file, and partner-file was reopened for add before submission.

File has been refreshed.

File was integrated from partner-file, accepting yours.

File was integrated into partner-file, accepting yours.

File has been abandoned.

None.

File is opened for move.

File has been added as part of a move.

File has been deleted as part of a move.

File was integrated from partner-file, accepting theirs and deleting the original.

File was integrated into partner-file, accepting merge.

File has not been resolved.

File was integrated from partner-file, accepting theirs.

File was integrated into partner-file, accepting theirs.

File was integrated from partner-file, accepting merge.

File was integrated into partner-file, accepting merge.

file was integrated from partner-file, and file was edited within the p4 resolve process. This allows you to determine whether the change should ever be integrated back; automated changes (merge from) needn't be, but original user edits (edit from) performed during the resolve should be.

File was integrated into partner-file, and partner-file was reopened for edit before submission.

File was purged.

File was imported.

File did not previously exist; it was created as a copy of partner-file.

Partner-file did not previously exist; it was created as a copy of file.

File was reverted.

Class summarizing the use of this file by another user.

Specifies other users who have a particular file open.

Metadata for a specific file stored in a Perforce repository.

Cast a FileSpec to FileMetatData

The location of the file in the depot

The location of the file in the client's file system, may be either a ClientPath or a LocalPath

Describes how, or if a file has been resolved.

The action used in resolving the file.

Specifies how file resolve operations were completed or will potentially be completed.

Flags to define the base file type.

An unspecified base file type.

Client Use: newlines translated. Server Storage: deltas in RCS format.

Client Use: raw bytes. Server Storage: compressed binary.

Client Use: symbolic link. Server Storage: deltas in RCS format.

Client Use: Mac resource + data. Server Storage: compressed AppleSingle.

Client Use: Mac resource fork. Server Storage: compressed binary.

Client Use: newlines translated. Server Storage: deltas in RCS format stored as UTF-8.

Client Use: newlines translated client file UTF-16 Server Storage: deltas in RCS format stored as UTF-8 in client byte order unless BOM overrides File is always written with a BOM A BOM is needed for automatic type detection

Flags to specify file type modifiers.

No flags.

+m always set modtime on client (overrides client's nomodtime).

+w always writable on client.

+x exec bit set on client.

+k $Keyword$ expansion of Id, Header, Author Date, DateTime, Change, File, Revision.

+ko $Keyword$ expansion of ID, Header only.

+l exclusive open: disallow multiple opens.

+C server stores compressed file per revision.

+D server stores deltas in RCS format.

+F server stores full file per revision.

+S server stores only single head revision.

+X server runs archive trigger to access files

Specifies a Perforce file type for a managed file.

P4Server Represents the connection to a Perforce Server using the the P4 Bridge DLL. It wraps the calls exported by the DLL and transforms the data types exported by the DLL as native C#.NET data types.

This file contains the internal data a methods that are not part of the public interface

Is the server Unicode enabled

What API level does the server support

Does the server require the login command be used

Marshall a returned pointer as a UTF-16 encoded string

Native pointer to the string UTF-16 String

Marshall a returned pointer as a UTF-8 encoded string

Native pointer to the string UTF-16 String

Translate a returned string based on the current encoding

Native pointer to the string UTF-16 String

Convert a returned c++ byte pointer (void *) to a byte[]

byte pointer byte count Converted byte[]

Marshal a String[] into an array of native pointers to strings in the correct encoding for Unicode enabled servers

The args to encode Count of args to encode Array of IntPtrs to encoded strings

Marshal a String into the correct encoding to pass to a Unicode enabled server.

String to encode IntPtr of the encoded string

Handle (pointer) to the P4BridgeServer wrapped by this P4Server

Internal creator for unit testing other classes

Set the character set encoding used to pass parameters to a Unicode enabled server.

This is handled automatically after connecting with a P4 server.

Holds the call back passed to the bridge used to receive the individual key:value pairs for an object