Perforce 2007.

2
Getting Started with P4V

July 2007
This manual copyright 2005-2007 Perforce Software.
All rights reserved.
Perforce software and documentation is available from http://www.perforce.com. You may download and use
Perforce programs, but you may not sell or redistribute them. You may download, print, copy, edit, and redistribute
the documentation, but you may not sell it, or sell any documentation derived from it. You may not modify or attempt
to reverse engineer the programs.
Perforce programs and documents are available from our Web site as is. No warranty or support is provided. Warran-
ties and support, along with higher capacity servers, are sold by Perforce Software.
Perforce Software assumes no responsibility or liability for any errors or inaccuracies that may appear in this book.
By downloading and using our programs and documents you agree to these terms.
Perforce and Inter-File Branching are trademarks of Perforce Software. Perforce software includes software developed
by the University of California, Berkeley and its contributors.
All other brands or product names are trademarks or registered trademarks of their respective companies or organi-
zations.
 Table of Contents

Basic Concepts.....................................................................................................5
Connecting to a Server.......................................................................................6
Navigating the Main Screen..............................................................................8
Setting up your workspace ...............................................................................9
Managing your Files ........................................................................................11
Getting files from the depot........................................................................11
Checking out files from the depot .............................................................12
Editing files in your workspace .................................................................12
Diffing files to view your edits...................................................................12
Discarding edits by reverting .....................................................................13
Checking your edits into the depot ...........................................................13
Displaying a file’s revision history ............................................................15
Graphical Reporting Tools...............................................................................15
Viewing file revisions as a diagram...........................................................16
Browsing file revisions using Time-lapse View .......................................17
Displaying folder history using the folder diff tool ................................18
Important and Useful Features.......................................................................19
Tooltips...........................................................................................................19
Drag and drop...............................................................................................19
File views .......................................................................................................20
Tearing off tabs .............................................................................................21
Setting Preferences .......................................................................................21
Migrating from P4Win .....................................................................................22
Next Steps ..........................................................................................................25

Perforce 2007.2 Getting Started with P4V 3

Table of Contents

4 Perforce 2007.2 Getting Started with P4V

 Getting Started with P4V

P4V, the Perforce Visual client, is Perforce’s cross-platform graphical user interface. You
can use P4V on Windows, Macintosh, UNIX and Linux computers and benefit from an
identical interface regardless of platform. This introductory guide provides some Perforce
basics and an orientation to P4V’s layout and features. For more details about P4V,
consult its online help. To learn more about Perforce, consult the user documentation on
our Web site.
To use Perforce to manage files, you typically connect to a Perforce server using a client
program like P4V. P4V enables you to check files in and out, and perform the various
other necessary tasks. The following sections tell you how to perform basic tasks and
point out powerful features and shortcuts.

Basic Concepts
P4V connects your computer to a Perforce server to move files between Perforce depots and
your workspace, as shown below.

Workspaces store ...your computer, ...the Perforce Server ...depots, repositories

local copies of files running P4V, which on a central server of files under
on... connects to... machine, which Perforce control
manages...

(client application) (server)

(workspace) (depot)

The definitions for these Perforce terms are as follows:

• Workspace: folders or directories on the client computer where you work on revisions
of files that are managed by Perforce.
• Client application: P4V (or another Perforce client application), running on your
computer, sending commands to the Perforce server and receiving results (files, status
information, and so on).

Perforce 2007.2 Getting Started with P4V 5

Connecting to a Server

• Server: the program that executes the commands sent by client programs, maintains
depot files, and tracks the state of workspaces. The Perforce Server typically runs on a
central machine, connected to client machines by the network.
• Depot: a file repository on the Perforce server. It contains all existing versions of all files
ever submitted to the server. There can be multiple depots on a single server. The
examples in this guide show a single depot.

Connecting to a Server
To gain access to your depots, you must connect to a server. To connect to a server:
1. Launch P4V. P4V displays the following connection dialog:

2. Specify the following settings (your Perforce administrator can provide you with this
information)
• Server: the name of the computer where your Perforce server is running.
• Port: the port number assigned to the server
• User: your Perforce user name

6 Perforce 2007.2 Getting Started with P4V

 Connecting to a Server

• Password: your Perforce user password, if required.

• Workspace: the name of your client workspace.
To display a list of existing users and workspaces, click Browse. (The server and
port must be specified before clicking Browse.)
If you have incorrectly specified a server setting, P4V displays a message like the
following:
Connect to server failed; check $P4PORT.
TCP connect to bigserver failed.
bigserver: host unknown.

3. To connect, click OK. P4V displays its main screen, as shown in the following figure.

The next section describes the main screen panes.

Perforce 2007.2 Getting Started with P4V 7

Navigating the Main Screen

Navigating the Main Screen

The following figure points out the panes and important features of the main screen. To see
what a button or screen element does, hold the mouse cursor over it. P4V displays a
descriptive tooltip.

Files in folder: lists the files in

the folder you are browsing in
the left pane. You can display
thumbnails of image files in
this pane by choosing View>
Show Files As.

Right pane: displays

Perforce specifications and
file information. To select the
specification you want to
display, choose the View
menu item or click the
corresponding toolbar
button.

Left pane: displays files Log pane: displays the Perforce commands
and folders. The Depot tab that P4V issues, plus error messages and
displays files in the results.
Perforce server, and the
Workspace tab displays
files in the workspace on
your computer

8 Perforce 2007.2 Getting Started with P4V

 Setting up your workspace

Setting up your workspace

Your Perforce administrator can do this for you, but it’s advisable to learn a few important
aspects of configuring your workspace, specifically (1) configuring the client root
directory and (2) configuring the client view.
To define a workspace, choose Connection > New Workspace.... To edit your current
workspace specification, choose Connection > Edit Current Workspace...
P4V displays the specification details in the lower portion of the right pane; for example:

View: enables you to restrict the Root: specifies the location on your
depot files to which you have access. computer under which Perforce stores
Set the view to ensure that you see copies of depot files. Specify a
only what you need to see. meaningful name, and make sure it’s
not set to your computer’s root
directory!

Perforce 2007.2 Getting Started with P4V 9

Setting up your workspace

To change a workspace specification, click . To display and set the client view
graphically, click the View tab. Browse to desired files and folders and context-click to
include them or exclude them from the client view, as shown in the following figure.

Click Save to save changes. Click the “x” to dismiss the Workspace
specification list.

10 Perforce 2007.2 Getting Started with P4V

 Managing your Files

Managing your Files

To manage files using Perforce, you typically perform the following sequence of tasks:
1. Get files from the depot.
2. Check out files you need to edit.
3. Edit files.
4. Check in your changes.
The following sections provide details about these and other common file management
tasks.

Getting files from the depot

To copy files from the depot to your workspace:
1. In the left pane, click the Depot tab.
2. Browse to the folder or file you want to retrieve.
3. Context-click the file or folder. To get the most recent version, choose Get Latest
Revision. To get an older version, choose Get Revision... and specify the version you
want.
In the Log pane, P4V displays a message like the following.
p4 sync //my-test-workspace/main/bark
//depot/main/bark#2 - added as c:\p4clients\my-test-workspace\main\bark
sync complete. 1 file affected.

In the left pane, note that the file displays a green dot, indicating that it is present in your
workspace:

Now the file resides in your workspace. If you want to edit the file, you must first check it
out.

Perforce 2007.2 Getting Started with P4V 11

Managing your Files

Checking out files from the depot

To check out a file in your workspace:
1. Browse to the desired file in the left pane Depot tab.
2. Context-click the file and choose Check Out.
In the Log pane, P4V displays a message like the following:
p4 edit //my-test-workspace/main/bark
//depot/main/bark#2 - opened for edit

In the left pane, note that the file displays a red check mark, indicating that you checked it
out:
Note that, when you check out a file, Perforce adds it to a changelist, which is a list of
related files. You can use changelists to group related files, for example, all files that
contain changes required to implement a new product feature. To view the changelist,
choose View > Pending Changelists or click in the toolbar.
Now you’re ready to edit your files.

Editing files in your workspace

To edit a checked-out file, double-click it (or context-click it and choose Open With..., then
select the desired application). P4V launches the corresponding editing application. Make
changes and save the file.
To select an application with which to open a file, choose File>Open With...>Choose
Application. Note that you can configure editors for different file types by choosing
Tools > Preferences... and clicking the Editors tab.

Diffing files to view your edits

To enable you to see what changes you’ve made, you can compare (diff) your edited file
with the version you checked out. To diff, context-click the checked-out file in the left

12 Perforce 2007.2 Getting Started with P4V

 Managing your Files

pane and choose Diff against Revision. P4V launches P4Diff, displaying the differences
between the two files. For example:

Discarding edits by reverting

If you decide you want to discard your changes:
1. Context-click the file in the left pane and choose Revert. P4V displays a warning
dialog.
2. Click OK. In the Log pane, P4V displays a message like the following:
p4 revert //my-test-workspace/main/bark
revert complete. 1 file affected.

Checking your edits into the depot

To check your changed file into the depot, perform the following steps.

Perforce 2007.2 Getting Started with P4V 13

Managing your Files

1. Display pending changelists: click in the toolbar. P4V displays a list of pending
changelists, as shown in the following figure. To display the files in a changelist,
expand it

2. Double-click the changelist in which your file is open. P4V displays the details, as
shown in the following figure.

3. Enter a description explaining the changes you made and click Submit. The Log
pane displays a message confirming that your changelist was submitted, similar to
the following.
Change 7941 submitted.
submit complete. 1 file affected.

14 Perforce 2007.2 Getting Started with P4V

 Graphical Reporting Tools

Displaying a file’s revision history

To view the changes made to a file or folder, context-click the file or folder and choose File
History or Folder History. The history for the selected file or folder is displayed in the
right pane. For example, the following figure shows the history of a folder, listing every
submitted changelist that affected a file in the folder.

Graphical Reporting Tools

P4V includes several valuable graphical reporting tools:
• Revision Graph: displays a diagram that shows the evolution of a selected file,
including files related by branching operations.
• Time-lapse View: shows how the contents of a selected text file changed from revision
to revision. You can easily sweep through revision ranges to locate passages of interest
and see when they were created and how they changed.
• Folder diff tool: enables you to see how the contents of a folder changed.
The following sections provide more details about these tools.

Perforce 2007.2 Getting Started with P4V 15

Graphical Reporting Tools

Viewing file revisions as a diagram

To display the revision diagram for a file, context-click the file in the left pane and choose
Revision Graph. P4V launches the tool, which displays a diagram like the following one.

This diagram shows you when the file was created and how it was branched, and enables
you to view details about each version submitted to the depot and navigate through the
graph using the navigation map. For more details about the information displayed in the
revision graph, consult P4V online help.

16 Perforce 2007.2 Getting Started with P4V

 Graphical Reporting Tools

Browsing file revisions using Time-lapse View

To browse the changes made to a text file, context-click the file in the left pane and choose
Time-lapse View. P4V launches the utility, which displays a screen like the following one.

Slider: move to
sweep through
revisions

Change detail: shows text that has been

added, changed, or deleted in a revision

Using Time-lapse View, you can sweep through all revisions of the file using the slider,
noting when changes were made and who made them. Again, for details, consult P4V
online help.

Perforce 2007.2 Getting Started with P4V 17

Graphical Reporting Tools

Displaying folder history using the folder diff tool

The folder diff tool enables you to see how the contents of a folder have changed: which
files are added, changed, or deleted. To view changes to a folder:
1. Context-click the folder in the left pane Depot or Workspace tab and choose Folder
History. In the right pane, P4V lists changelists that affected the folder, for example:

2. To display the changes that occurred between two revisions of a folder, drag and
drop one of the revisions on the other.
P4V displays the changes as shown in the following figure. This example shows that,
between the selected revisions, a file was edited and checked in. File highlights are color-
coded to indicate additions, changes, and deletions. Expand folders and scroll to locate
changes of interest. To skip to the next or previous change, click the right and left arrows.

Click to browse changes.

18 Perforce 2007.2 Getting Started with P4V

 Important and Useful Features

Important and Useful Features

Among the many features provided by P4V, the following are especially useful:
• Tooltips: to get more information about an object, place your mouse cursor over it. P4V
displays a popup dialog containing more details.
• Drag and drop: P4V includes numerous drag and drop shortcuts for common
operations.
• File views: P4V enables you to preview graphics files using thumbnails.
• Tear off windows: to create a separate window displaying a specification you want to
keep on display, you can tear it off.
The following sections provide more details.

Tooltips
P4V provides tooltips for many objects on the screen. For example, to display the status of
a file, hold the mouse cursor over the file in the left pane. P4V displays a tooltip like the
following one.

Another example: to display a changelist description, click in the toolbar and hold the
mouse cursor over the changelist in the right pane. There are tooltips for all the P4V
buttons, too.

Drag and drop

P4V provides drag and drop shortcuts for common tasks. Drag and drop can simplify
operations on large groups of files. For example, to check out all the files in a folder, drag
the folder to a changelist. To diff two files, drag one to the other. For details about drag
and drop shortcuts, refer to the P4V online help.

Perforce 2007.2 Getting Started with P4V 19

Important and Useful Features

File views
If you use Perforce to manage graphics files, P4V’s thumbnail views enable you to
preview the files. To display thumbnails, click the Files tab in the right pane, then select
the desired thumbnail size from the title bar.

P4V displays thumbnails as shown in the following example.

20 Perforce 2007.2 Getting Started with P4V

 Important and Useful Features

Tearing off tabs

To keep a tab open, you can undock it. For example, context-click a file and choose file
History, then choose Window > Undock Tab. P4V opens a separate window for it, as
shown in the following figure.

To restore it to the main window, choose Window > Dock Window.

Setting Preferences
To configure P4V, choose Tools > Preferences. The tabbed Preferences dialog is
displayed. In particular, the Editor tab enables you to associate applications with file
types, overriding any operating system associations. The Diff and Merge tabs enable you
to configure external applications, in case you prefer tools other than those that are
bundled with P4V.

Perforce 2007.2 Getting Started with P4V 21

Migrating from P4Win

Migrating from P4Win

If you’re moving from P4Win to P4V, here’s a list of equivalent operations to help you in
your transition.
P4Win Menu Item Menu P4V Menu Item Menu Notes
Add to Source File Mark for Add File Applies only
Control… to files in the
Workspace
Tree
Diff 2 Files, File Diff... Tools
Folders or
Revisions
Diff Client File vs. File Diff... Tools Or context-
Depot File click on file
and choose
Diff Against
Have Revision
Explore File Show in Explorer File
Integrate Using File Integrate... File
Filespec or
Branchspec
Open for Delete File Mark for Delete File
Open for Edit File Check Out File
Properties File Files in Folder View File properties
are displayed
in the Details
pane at the
bottom of the
Files in Folder
view
Remove from File Remove from File
Client Workspace
Rename File Rename/Move… File
Revision File History View Alternatively
History… context click
on file and
choose File
History

22 Perforce 2007.2 Getting Started with P4V

 Migrating from P4Win

P4Win Menu Item Menu P4V Menu Item Menu Notes

View File… File Open File Alternatively
Check File>More Reconcile Offline Tools Applies only
Consistency Work... to folders in
the Workspace
Tree
Auto Resolve… File>Resolve Resolve… File
Interactively… File>Resolve Resolve… File
[Resolve]
Schedule File for File>Resolve Get Latest Revision File
Resolve
Sync to Head File>Sync Get Latest Revision File
Revision
Sync... File>Sync Get Revision… File
Find File Edit Find File… Edit
Matching
Pattern…
Find File Under Edit Find File… Edit
Selected Folder…
Bookmarks View Bookmarks Tools
Client View of View Depot Tree View Restrict to
Depot client view by
choosing
View->Filter
Depot->Tree
Restricted to
Workspace
View
ClientSpecs View Workspaces View
Entire Depot View Depot Tree View Show the
entire depot
by choosing
View->Filter
Depot->Entire
Depot Tree
Local View of View Workspace Tree View
Client Tree

Perforce 2007.2 Getting Started with P4V 23

Migrating from P4Win

P4Win Menu Item Menu P4V Menu Item Menu Notes

Show Deleted View Show Deleted Depot View-
Depot Files Files >Filter
Depot
Favorite Settings Favorite Connections Connection
Connections
Logout Settings Log Off Connection
Options… Settings Preferences… Edit
Port Client User Settings Open Recent Connection
History
Switch Port Settings Open Connection… Connection
Client User…
Describe… Changelist Branchspec Label Clientspec
Set Password for User Change Password… Connection
(current user)…

24 Perforce 2007.2 Getting Started with P4V

 Next Steps

Next Steps
This guide helps you to start working with files using P4V and points out important basic
features, but P4V enables you to do much more: create jobs, branch groups of files, and
handle file conflicts that arise in team development settings.
Perforce superusers can perform administrative operations by choosing Tools >
Administration. Using the Administration tool, superusers can manage users and groups,
and their access to files and folders within the depot. Some administrative functions must
still be performed using the Perforce command-line client (p4). For details, see the Perforce
Command Reference and the Perforce System Administrator’s Guide.
To become expert with P4V:
• Consult the P4V online help and read the Perforce user documentation available from
the Perforce Web site.
• Use tooltips.
• Pay attention to the file icons and decorations in the left pane. The decorations and
icons display a great deal of information about the type and status of a file.
• Start reading the Log pane.
• Learn drag and drop shortcuts to simplify operations on large sets of files.
• Use P4V views and filtering features to enable you to selectively display information.
To get the whole picture, read the P4V online help, Introducing Perforce and the Perforce
System Administrator’s Guide. The guides, which are available from the Perforce web site,
describe the full set of features that the Perforce Server provides. Perforce Technical
Support is always ready to help you, and there’s a thriving community of Perforce users
active on the perforce-users mailing list. Consult our web site for details.

Perforce 2007.2 Getting Started with P4V 25

Next Steps

26 Perforce 2007.2 Getting Started with P4V