You can add commands and folders to the Tools menu. The tools can then be accessed from the Tools menu in P4V and optionally from context menus. For each custom tool, you can also create a shortcut. You can export your custom tool definitions to a file from which other P4V users can import them.
P4V
launches the specified custom tool in an external process.
Perforce
settings are exported to the external process as follows: the
P4PORT
, P4USER
, P4CLIENT
and
P4CHARSET
settings in effect for the
P4V
connection are exported to the external process, plus any other
Perforce
settings present in the environment in which
P4V
is running, including command-line arguments specified when
P4V
was launched and global settings (on Windows machines, settings
configured using the p4 set -s
command).
If the P4CONFIG
environment variable is set, the tool
recognizes any P4CONFIG
files present in the file hierarchy
on which it is operating. Settings in P4CONFIG
files
override settings in the environment. To ensure that
P4CONFIG
settings do not override environment settings,
select Ignore P4CONFIG files. (For details about config files,
refer to the P4 User’s Guide.) If you are passing arguments to a
custom tool, select Ignore P4CONFIG filesto ensure that the server
settings used by the custom tool correspond to the values that are
passed.
On a Mac, custom tools are not launched from a shell by default. For
tools that must recognize P4CONFIG
settings, create a script
that launches a shell before invoking the tool, or define
P4CONFIG
globally (for example, in
/etc/profile
, /etc/profile.local
, or
/etc/csh.login
). To spawn a shell using Bourne shell, issue
the #!/bin/sh
command. For the C shell, issue the
#!/bin/tcsh
command.
If you need to keep a tool running or launch another application, run it in the background and exit the shell or process that was launched by the custom tool. This approach ensures that you do not block another tool and that the application will remain open when you exit P4V.
To add custom tools to P4V:
Choose Tools > Manage Custom Tools.
The Manage Custom Tools dialog is displayed.
Click New and choose Tool….
The Add Custom Tool dialog is displayed.
Specify the application that you want to associate with this command in the Application field. To browse to the application, click Browse. (You can drag and drop the application from an Explorer or Finder window to the Application field.)
To define tools that issue p4 commands, specify p4
in
the Application field and the command and desired arguments
( for example, fix -c %c job000001
) in the
Arguments field. In general, be sure to specify the
application and arguments separately in the fields provided.
In the Arguments field, enter command arguments using the specifiers listed in the following table.
Some arguments have an uppercase and lowercase form. To run the tool once, submitting all values together, specify the uppercase argument. To run the tool once for each value, specify the lowercase form.
|
Selected label |
|
Selected branch |
|
Selected changelists |
|
Selected files or folders (depot syntax used for depot files) |
|
Selected files (workspace syntax used for depot files) |
|
Selected workspace specifications |
|
Selected jobs |
|
Depends on which pane has focus:
|
|
Selected pending changelists |
|
Selected submitted changelists |
|
Selected stream |
|
Selected user |
|
Current workspace specification |
|
Current port |
|
Current client workspace root |
|
Current user |
|
Arguments from prompt dialog |
|
Literal '%' character |
|
Literal '$' character |
Notes about arguments:
To specify values containing spaces, double-quote them. For example:
"C:\Program Files\scripts\changelistreport.pl" %p
%
argument per tool
definition.Uppercase specifiers send values to the command as a group, while lowercase specifiers run the command once for each value.
For example: mycommand %F
runs
mycommand arg1 arg2 arg3
and
mycommand %f
runs mycommand arg1;
mycommand arg2; mycommand arg3
.
$D
), you must warn users to avoid the "&"
character when they enter a string value in your custom tool
prompt. The "&" value is a special character.In the Start in field, specify the directory where you want the command to execute. You can specify the directory using operating system syntax (for example:
C:\tmp, or /tmp
), or specify %f
,
which uses the directory of the selected file.
If you specify %f
, omit any other values. For
example, %f\temp
is invalid.
To add a shortcut for the tool, double-click the Shortcut column and enter the desired key combination.
If a shortcut is reserved or already in use, P4V displays a warning message.
You can export the tools you’ve defined to an XML file that other P4V users can import. Likewise, you can import tools that other P4V users have created.
To import tools:
Choose Tools > Manage Custom Tools…
The Manage Custom Tools dialog is displayed.
Click Import tools…
P4V displays the Read Custom Tools from a File dialog.
Enter the file name or browse to the file and click Open.
The Import Preview dialog is displayed.
Click Import.
The tool definitions are imported.
To export tools:
Choose Tools > Manage Custom Tools…
The Manage Custom Tools dialog is displayed.
Click Export tools…
The Export Preview dialog is displayed.
Select the tools you want to export and click Export.
The Save Custom Tools to a File dialog is displayed.
On Windows, if a tool does not run, verify that the files that it opens have their extensions mapped to the required application.