Documentation and Other Resources
This chapter describe the resources available for learning more about Helix.
To learn more about Helix
To obtain online help from within all Helix applications:
- Use the help menu from within graphical Perforce applications
- Type
p4 helpfrom the command line for help with the Command-Line Client
Documentation for Helix is available on the web at: http://www.perforce.com/documentation
The Helix Knowledge Base. A complete list of articles is available: http://answers.perforce.com
The Helix Forums are a place for users to ask questions and to hear from other users: http://forums.perforce.com/
The perforce-user mailing list is mirrored on the Helix Forums:
http://maillist.perforce.com/mailman/listinfo/perforce-user
Perforce support personnel are available for email and telephone support. Perforce also offers training, consulting, and other professional services. For details, see: http://www.perforce.com/support-services
Helix documentation
The following table lists and describes key documents for Helix users, developers, and administrators. For complete information, see the following:
http://www.perforce.com/documentation
| For specific information about… | See this documentation… |
|---|---|
|
Perforce’s Git repo management web application-based on GitLab. |
|
|
The enterprise edition of Perforce’s Git repo management web application. |
|
|
Perforce’s code review and code collaboration tool. |
|
|
Perforce’s plugin for integrating Git users with Perforce users. |
|
|
Introduction to version control concepts and workflows; Helix architecture, and related products. |
|
|
Using the command-line interface to perform software version management and codeline management; working with Helix streams; jobs, reporting, scripting, and more. |
|
|
Basic workflows using P4V, the cross-platform Helix desktop client. |
|
|
Working with personal and shared servers and understanding the distributed versioning features of the Helix Versioning engine. |
|
|
|
P4 Command Reference, |
|
Installing and administering the Helix versioning engine, including user management, security settings. |
|
|
Installing and configuring Helix servers (proxies, replicas, and edge servers) in a distributed environment. |
Helix Versioning Engine Administrator Guide: Multi-site Deployment |
|
Helix plug-ins and integrations. |
IDEs: Using IDE Plug-ins |
|
Developing custom Helix applications using the Helix C/C++ API. |
|
|
Working with Helix in Ruby, Perl, Python, and PHP. |
Syntax conventions
Helix documentation uses the following syntax conventions to describe command line syntax.
| Notation | Meaning |
|---|---|
|
|
Monospace font indicates a word or other notation that must be used in the command exactly as shown. |
|
italics |
Italics indicate a parameter for which you must supply specific information. For example, for a serverid parameter, you must supply the id of the server. |
|
[ |
Square brackets indicate that the enclosed elements are optional. Omit the brackets when you compose the command. Elements that are not bracketed are required. |
|
… |
Ellipses (…) indicate that the preceding element can be repeated as often as needed. |
|
element1 | element2 |
A vertical bar ( | ) indicates that either element1 or element2 is required. |
Please give us feedback
We are interested in receiving opinions on this manual from our users. In particular, we’d like to hear from users who have never used Perforce before. Does this guide teach the topic well? Please let us know what you think; we can be reached at manual@perforce.com.
If you need assistance, or wish to provide feedback about any of our products, contact support@perforce.com.
Download URLs
To download Helix products, visit: http://www.perforce.com/downloads
Videos
To view tutorials explaining how Helix products work, visit: http://www.perforce.com/resources/tutorials