A Perforce client spec defines your workspace. You must create a client spec before you can do any work with files in your workspace. To create or edit your client spec use Go To->Edit Client Spec.
If you are a new Perforce user just starting out, the only fields you have to edit are Root and View, as described below. Then just click "Save" and return to the Path Browser. Later, when you have a better idea of what you can do with your client spec, you can edit it again and select different options.
A client spec consists of the following values:
- Client:
- The unique name of your current client workspace. To set a different client workspace name, use Go To->Settings.
- Update:
- Shows when your client spec was last changed.
- Access:
- Shows when your workspace was last used.
- Owner:
- The user who "owns" the workspace and the client spec. (Unless the client spec is locked, ownership has no particular privilege.)
- Host:
- The name of the workstation or computer on which your workspace is located. P4Web uses this value to prevent you from accidentally using your workspace from the wrong machine.
If your workspace is on a shared filesystem, and you want to use it from more than one machine, leave the host value blank.
- Description:
- Optional information that can be used to described what this client workspace is used for.
- Root:
- The location of the the root of your workspace on the local filesystem. You should set this once, when you are first creating your client spec. Use the directory naming syntax recognized by your machine (for example, "C:\WS" on Windows, or "/usr/team/bill/ws" on Unix).
If you ever want to change your workspace root, you should first submit your opened files, then remove all Perforce-managed files from your workspace, and then use the Edit Client Spec page to change the root. After saving the new client spec, sync your workspace and files will be written to the new location.
- Options:
- Controls some optional characteristics of how Perforce operates in this client workspaces. See Client Workspace Options, below.
- LineEnd:
- Controls how line endings in text files are translated when files are transmitted between the depot and your workspace. See Translating Line-end Characters, below.
- View:
- Describes how depot files will be "mapped" into your workspace. For example, if your client workspace name is "PatWS" and its root is "C:\WS", this view:
//depot/projects/saturn/... //PatWS/SAT/...will map all the files the //depot/projects/saturn path to a matching directory hierarchy under "C:\WS\SAT".If you're creating your first workspace, you can leave the default values provided in the View field. Be aware, however, that if your Perforce server manages very large depots, the default view can cause your workspace commands to run slowly. For better performance, define a view that maps to only the depot paths you are interested in working with.
See the Perforce User's Guide for more details on client view mapping.
These optional behaviors can be defined for your client workspace:
Will all files be writable in the workspace, or only files that have been opened for edit?
The default value is off (noallwrite), so that only files you've opened will be writable.
Will data sent between your client workspace and the Perforce server be compressed?
The default value is off (nocompress). Over a LAN or high-bandwidth connection, there's little benefit to compressing this data, but if you're operating over a slow link, turning this option on will help.
Lock the client spec?
The default value is off (unlocked). Anyone can use the workspace or edit the client spec. If you turn this on, only the user shown in the Owner field will be able to use the workspace or edit the specification.
Should a sync command that deletes all files in a directory also delete the directory?
The default value is off (normdir). A sync command that removes all files in a directory will leave empty directories. If you turn this option on, empty directories will be removed.
Should the sync command overwrite any writable, unopened files?
The default value is off (noclobber). If you turn this option on, any writable, unopened files in your workspace can be overwritten when you run sync. This includes files made writable either either from using the allwrite option described above, or by manually changing permissions from within your local operating system.
What should the modification time on files in your workspace be set to when copied in by the sync command?
By default, the modification time of unopened files on your workspace files shows when they were synced. Choosing this option will cause sync to set each file's modification time to the timestamp associated with it when it was submitted to the depot.
Text files contain special characters that indicate where line endings occur. Different operating systems use different characters (usually CR and/or LF). When Perforce copies files from the depot into your workspace, it translates line endings as appropriate for your workspace machine. When it sends file content from your workspace to the depot, it translates them back.
The "LineEnd" field in the client spec lets you control the line-end characters Perforce uses when it reads and writes text files in your workspace. Choices are:
| local | Use whatever line endings the local operating system uses. This is the default, and the preferred setting for client workspaces that are not shared. |
| unix | Use UNIX-style line endings, LF. |
| mac | Use Macintosh-style line endings, CR. |
| win | Use Windows-style line-endings, CRLF. |
| share | Write files using UNIX-style line endings, but read files with either UNIX- or Windows-style line endings. |
Note: Changing the "LineEnd" setting in your client spec doesn't affect the files Perforce has already put in your workspace. You must re-sync your files using the "force" option to make Perforce rewrite the files with the new line-end characters.