<html> <head> <title>BranchView installation and configuration</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <meta name="author" content="Andrei Loskutov"> <meta name="copyright" content="(c) 1997/98/99/2000/2001/2002, Andrei Loskutov"> <meta name="description" content="BranchView is Andrei Loskutov Perforce depot visualisation tool in Java"> <meta name="keywords" content="Hannover, Java, Perforce, BranchView, Programmieren, Nienburg, Andrej, Andy, Andrei, Moskau, Loskutov"> <meta name="Expires" content="Sun, 28 Feb 1999 21:29:02 GMT"> <meta name="ROBOTS" content="INDEX,FOLLOW,ALL"> <link rel="stylesheet" href="../styles.css" type="text/css"> <link rel="SHORTCUT ICON" href="../../favicon.ico"> </head> <body bgcolor="#FFFFFF" text="#000000"> <p><a href="../index.html">Home</a></p> <hr size="1"> <h1>BranchView installation and configuration</h1> <blockquote> <p>Whole application is only one jar file, which can be put down in any directory. If a P4 Client directory is in the system path, you have nothing more to do, otherwise you must give BranchView one extra starting parameter: where it is to look for Perforce. Since it does not have side effects and is fastest, it recommends to copy the program simply into the P4 Client directory.</p> <p>For the correct function of the integrated Diff - tool you must have the freely available program ExamDiff™ from PrestoSoft™(<a href="http://www.prestosoft.com/examdiff/">http://www.prestosoft.com/examdiff/</a>) in the system path. If ExamDiff does not present in the system path or another Diff - tool is used, you must extra configure BranchView for this (to it later).. </p> <p><b>Note</b>: If you use <a href="../BranchViewWrapper.html">BranchView plugin for Eclipse</a>, see <a href="../BranchViewWrapper.html">here</a> for additional information. With <a href="../BranchViewWrapper.html">BranchView plugin for Eclipse</a> you don't need any external diff tool, because BranchView plugin uses Eclipse's own compare tool.</p> <h2>Setup of Perforce - Client.</h2> <p>In order to be able to start application from the Perforce Client, you must add in the P4 Client under <span class="code">Tools/Customize... </span>a new Tool.</p> <p>Then click "<span class="code">Add</span>", then any name for the menu entry, then "<span class="code">Ok</span>".</p> <p>In the field "<span class="code">Command:</span>" the following must be registered (brackets to mean that contents are optional):</p> <p class="code"><Path to javaw.exe>javaw.exe -jar tp4branchview.jar, </p> <p>(for those of us with non-Windows OS: replace 'javaw' always through 'java')</p> <p>If javaw.exe is in the system path, you does not need to enter the path to javaw.exe, following is enough:</p> <p class="code">javaw.exe -jar tp4branchview.jar</p> <p>In the field "<span class="code">Arguments:</span>" insert the starting parameters of the program, that is in the usual case:</p> <p class="code">$u $c $p %D</p> <p>The field "<span class="code">Initial directory:</span>" should contain path to the directory, where tp4branchview.jar is, e.g.</p> <p class="code">d:\programme\perforce</p> <p>Then click on "<span class="code">Ok</span>" and under to the menu Tools appears now a new entry.</p> <p>Otherwise, you can simply import tools.txt from BranchView distribution package, simply set right path to Perforce ;) .</p> <h2><br> Starting parameter and configuration file.</h2> <p><br> Usually you don't need any one start parameter except file(directory) name for BranchView. </p> <p> <b>Example</b>:</p> <pre>javaw.exe -jar tp4branchview.jar //depot/java/MyClass.java</pre> <p>or</p> <pre>javaw.exe -jar tp4branchview.jar //depot/java/... </pre> <p>for whole directory. </p> <p> </p> <p>BranchView expects the following parameters (sequence and large/lower case are important!): </p> <table width="88%" border="0" cellspacing="2" cellpadding="3" bgcolor="#E5E5E5"> <tr align="center"> <td valign="top" bgcolor="#E5E5E5">Number of the parameters in the command line</td> <td valign="top" bgcolor="#E5E5E5">BranchView parameter</td> <td valign="top" bgcolor="#E5E5E5">Description</td> <td valign="top" bgcolor="#E5E5E5">P4 Client Parameter</td> </tr> <tr valign="top" bgcolor="#FFFFFF"> <td align="center">1</td> <td align="center"><Value></td> <td>P4 user name</td> <td align="center">$u</td> </tr> <tr valign="top" bgcolor="#FFFFFF"> <td align="center">2</td> <td align="center"><Value></td> <td>P4 Clientname like 'user-hostname '</td> <td align="center">$c</td> </tr> <tr valign="top" bgcolor="#FFFFFF"> <td align="center">3</td> <td align="center"><Value></td> <td>P4 Server port like 'server_name.domain_name:port'</td> <td align="center">$p</td> </tr> <tr valign="top" bgcolor="#FFFFFF"> <td align="center">4</td> <td align="center"><Value></td> <td>P4 file path to the desired file as '//a/b/c.txt'</td> <td align="center">%D</td> </tr> <tr valign="top" bgcolor="#FFFFFF"> <td align="center">5, optional:</td> <td align="center"><Value></td> <td>P4 program path like 'c:\progra~2\perforce'</td> <td align="center"> </td> </tr> <tr valign="top" bgcolor="#FFFFFF"> <td align="center">6, optional:</td> <td align="center"><Value></td> <td>User password</td> <td align="center"> </td> </tr> <tr valign="top" bgcolor="#FFFFFF" align="left"> <td colspan="4"> <p><b>Note:</b> If you will use one of parameter <b>1 - 3 </b>above, all other parameters from <b>1 to 3 </b>must be set too, but you can use 'P4 file path to the desired file' alone or freely with any parameter below.<br> <b>Examples:</b><br> javaw.exe -jar tp4branchview.jar $u $c $p %D<br> javaw.exe -jar tp4branchview.jar $u $c $p %D c:\progra~2\perforce<br> javaw.exe -jar tp4branchview.jar $u $c $p %D c:\progra~2\perforce xxxxxx<br> javaw.exe -jar tp4branchview.jar %D</p></td> </tr> <tr valign="top" bgcolor="#FFFFFF"> <td align="center">Optional:</td> <td align="center">'-stat'</td> <td colspan="2">Flag, in order the write all received P4 data into the file tp4branchview.log in user directory<br> <b>Example:</b> javaw.exe -jar tp4branchview.jar %D -stat</td> </tr> <tr valign="top" bgcolor="#FFFFFF"> <td align="center">Optional:</td> <td align="center">'-offline'</td> <td colspan="2"> <p>Flag, in order to load the source of the data for the view from file tp4branchview.log in user directory <br> <b>Example:</b> javaw.exe -jar tp4branchview.jar -offline</p></td> </tr> <tr valign="top" bgcolor="#FFFFFF" align="left"> <td colspan="4"><b>Note:</b> current parameter handling is not usual, and i will change this at next time<br> (if i have time at next ;) ).</td> </tr> </table> <p> These and other parameters can be handed with configuration file ' <span class="code">tp4branchview.ini</span> ', which always be generated by BranchView in user home directory<br> on Windows NT: <br> <span class="code">%SystemRoot%\profiles\%UserName%</span>, <br> on Windows 2000: <span class="code"><br> %SystemDrive%\My documents\%UserName%</span></p> <p>Example of such a file:</p> <blockquote> <p class="code"># comment: that is a comment line<br> p4.user=Andy_the_Great<br> p4.client=andy<br> p4.port=1666<br> p4.executable=p4<br> p4.password=xxxxxx<br> debug\ mode=false<br> diff\ tool\ path="c:\program files\examdiff.exe"</p> </blockquote> <p>The sequence of the parameters corresponds here to the sequence of the parameters in the table, can be however selected arbitrarily. The names of the parameters must 1:1 match indicated here. Notice, that each time BranchView window will be closed, BranchView will overwrite properties file.</p> </blockquote> <hr size="1"> <p><a href="../index.html">Home</a></p> </body> </html>
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#5 | 2735 | andrei_loskutov | sources are now included to binary distribution at http://andrei.gmxhome.de/perforce/index.html | ||
#4 | 2553 | andrei_loskutov | Docu update for 1.3 version | ||
#3 | 2222 | andrei_loskutov |
#13.10.2002 22:16 Revision 1.2.1 1) Documentation task is finished... Yes!!! 2) New feature: copy P4 depot path 3) Some small fixes to menu shortkeys belongs ctrl + c and ctrl + d 4) Clipboard fix because of JDK 1.2 - 1.3 bug 5) Smallest refactoring on some methods. 6) Html help updated |
||
#2 | 2007 | andrei_loskutov | english documentation now available | ||
#1 | 1999 | andrei_loskutov | start english manual |