How to use this Guide

This reference includes every Helix Server command, environment variable, and configurable, and assumes knowledge of the concepts in Solutions Overview: Helix Version Control System.

Search within this guide

Multiple search terms find topics with one or more of the terms, and each term gets a different highlight color:

For an exact multi-word search, enclose the set of terms within quotes to form a single string:

For an exact single-word search, use quotes:

  • work also finds workspace, but "work" excludes workspace
  • request also finds requests and requesting, but "request" excludes them
  • configuration also finds topics with configuring, but "configuration" excludes them

You can search for any string on a page with Command-F on Mac or CTRL+F on Windows

Navigation

Browse to the next or previous heading with arrow buttons:

See the top of any page to knows its location within the book:

Use the links to resources at the footer of each page:

Resize the Content pane as needed:

Tip

When sharing URLs, you can ignore the extra characters at the end of each page's URL because standard URLs do work. For example:

https://www.perforce.com/perforce/doc.current/manuals/cmdref/#CmdRef/p4_add.htm

or

https://www.perforce.com/perforce/doc.current/manuals/cmdref/#CmdRef/configurables.configurables.html#auth.default.method

Feedback

How can we improve this manual? Email us at manual@perforce.com.

Other documentation

See https://www.perforce.com/support/self-service-resources/documentation.

Syntax conventions

Helix documentation uses the following syntax conventions to describe command line syntax.

Notation Meaning
literal Must be used in the command exactly as shown.
italics A parameter for which you must supply specific information. For example, for a serverid parameter, supply the ID of the server.
[-f] The enclosed elements are optional. Omit the brackets when you compose the command.
...
  • Repeats as much as needed:

    • alias-name[[$(arg1)...[$(argn)]]=transformation
  • Recursive for all directory levels:
    • clone perforce:1666 //depot/main/p4... ~/local-repos/main

    • p4 repos -e //gra.../rep...
element1 | element2 Either element1 or element2 is required.