Loading...
Helix SwarmHelix Swarm
Loading...

vcp.html

  • //
  • guest/
  • dimitry_andric/
  • revml/
  • main/
  • product/
  • release/
  • 0.90/
  • html/
  • vcp.html #1
  • View
  • Commits
  • Open Download .zip Download (10 KB) 
  1. <html><head><title>vcp - Copy versions of files between repositories and/or RevML</title></head><body><h1><a name="NAME">NAME
  2.  
  3. </a></h1><p>vcp - Copy versions of files between repositories and/or RevML
  4.  
  5. <p><hr><h1><a name="SYNOPSIS">SYNOPSIS
  6.  
  7. </a></h1><pre>   # interactive mode:
  8.  
  9. </pre><pre>   vcp [vcp_opts]
  10.  
  11. </pre><pre>   # scriptable command line mode:
  12.  
  13. </pre><pre>   vcp [vcp_opts] &lt;source&gt; &lt;dest&gt;
  14.  
  15. </pre><pre>   # getting options from a file:
  16.  
  17. </pre><pre>   vcp vcp:config.vcp
  18.  
  19. </pre><pre>   # help output:
  20.  
  21. </pre><pre>   vcp help
  22.    vcp help [topic]
  23.  
  24. </pre><p><hr><h1><a name="DESCRIPTION">DESCRIPTION
  25.  
  26. </a></h1><p><code>vcp</code> ('version copy') copies versions of files from one repository to another,
  27. translating as much metadata as possible along the way.  This allows you to
  28. copy and translate files and their histories between revision storage systems.
  29.  
  30. <p>Supported source and destination types are <code>cvs:</code>, <code>p4:</code>, and <code>revml:</code>.
  31.  
  32. <h2><a name="Copying_Versions">Copying Versions
  33.  
  34. </a></h2><p>The general syntax of the vcp command line is:
  35.  
  36. <pre>   vcp [&lt;vcp options&gt;] &lt;source&gt; &lt;dest&gt;
  37.  
  38. </pre><p>The three portions of the command line are:
  39.  
  40. <dl><dt><a name="_vcp_options_"><strong><p><code>&lt;vcp options&gt;</code>
  41.  
  42. </strong></a><dd>Command line options that control the operation of the <code>vcp</code> command, like
  43. <code>-d</code> for debugging or <code>-h</code> for help.  There are very few global options,
  44. these are covered below. Note that they must come before the
  45. <code>&lt;source&gt;</code> specification.
  46.  
  47. <dt><a name="_source_"><strong><p><code>&lt;source&gt;</code>
  48.  
  49. </strong></a><dd>Were to extract versions from, including any command line options needed to
  50. control what is extracted and how.  See the next section.
  51.  
  52. <dt><a name="_dest_"><strong><p><code>&lt;dest&gt;</code>
  53.  
  54. </strong></a><dd>Where to insert versions, including any command line options needed to control
  55. how files are stored.  See the next section.
  56.  
  57. </dl><h2><a name="Specifying_Repositories">Specifying Repositories
  58.  
  59. </a></h2><p>The <code>&lt;source&gt;</code> and <code>&lt;dest&gt;</code> specifications specify a
  60. repository and provide any options needed for accessing that repository.
  61.  
  62. <p>These spefications may be a simple filename for reading or writing RevML
  63. files (if the requisite XML handling modules are installed). or a full
  64. repository specification like <code>cvs:/home/cvs/root:module</code> or
  65. <code>p4:user:password@server:port://depot/dir</code>.
  66.  
  67. <p>When using the long form to access a repository, <code>&lt;source&gt;</code> and
  68. <code>&lt;dest&gt;</code> specification have several fields delimited by <code>:</code>
  69. and <code>@</code>, and may have trailing command line options.  The full (rarely
  70. used) syntax is:
  71.  
  72. <pre>   scheme:user(view):password@repository:filespec [&lt;options&gt;]
  73.  
  74. </pre><p>where
  75.  
  76. <dl><dt><a name="scheme_"><strong><p><code>scheme:</code>
  77.  
  78. </strong></a><dd>The repository type (<code>p4:</code>, <code>cvs:</code>, <code>revml:</code>).
  79.  
  80. <dt><a name="user"><strong><p><code>user</code>, <code>view</code>, and <code>password</code>
  81.  
  82. </strong></a><dd>Optional values for authenticating with the repository and identifying which
  83. view to use.  <code>cvs</code> does not use <code>view</code>.  For <code>p4</code>, <code>view</code> is the client
  84. setting (equibalent to setting <code>P4CLIENT</code> or using <code>p4</code>'s <code>-c</code> option).
  85.  
  86. <dt><a name="repository"><strong><p><code>repository</code>
  87.  
  88. </strong></a><dd>The repository spec, CVSROOT for CVS or P4PORT for p4.
  89.  
  90. <dt><a name="filespec"><strong><p><code>filespec</code>
  91.  
  92. </strong></a><dd>Which versions of what files to move.  As much as possible, this spec is
  93. similar to the native filespecs used by the repository indicated by the scheme.
  94.  
  95. <dt><a name="_options_"><strong><p><code>&lt;options&gt;</code>
  96.  
  97. </strong></a><dd>Command line options that usually mimic the options provided by the underlying
  98. repositories' command line tools (<code>cvs</code>, <code>p4</code>, etc).
  99.  
  100. </dl><p>Most of these fields are omitted in practice, only the <code>scheme</code> field is
  101. required, though (in most cases) the <code>repository</code> field is also needed unless
  102. you set the appropriate environment variables (<code>CVSROOT</code>, <code>P4PORT</code>, etc).
  103.  
  104. <p>The a bit confusing, here are some examples specs:
  105.  
  106. <pre>   cvs:server:/foo
  107.    p4:user@server://depot/foo/...
  108.    p4:user:password@public.perforce.com:1666://depot/foo/...
  109.  
  110. </pre><p>Options and formats for of individual schemes can be found in the relevant
  111. help topics, for instance:
  112.  
  113. <pre>   vcp help source::cvs
  114.  
  115. </pre><p>Run <code>vcp help</code> for a list of topics.
  116.  
  117. <p>When reading and writing RevML files, a simple filename will do
  118. (although the long form may also be used).  The special value &quot;-&quot; means
  119. to read/write stdin and stdout when used as a source or destination
  120. name, respectively.  &quot;-&quot; is assumed if a specification is not provided,
  121. so these invocations all accomplish the same thing, reading and writing
  122. RevML:
  123.  
  124. <pre>   vcp
  125.    vcp -
  126.    vcp revml:-
  127.    vcp revml:
  128.    vcp - -
  129.    vcp - revml:-
  130.    vcp - revml:
  131.    vcp revml:- revml:-
  132.    vcp revml: revml:
  133.  
  134. </pre><h2><a name="vcp_Options"><code>vcp</code> Options
  135.  
  136. </a></h2><p>All general options to vcp must precede the <code>&lt;source&gt;</code>.
  137. Scheme-specific options must be placed immediately after the
  138. <code>&lt;source&gt;</code> or <code>&lt;dest&gt;</code> spec and before the next one.
  139.  
  140. <dl><dt><a name="_debug_d_"><strong><p>--debug, -d
  141.  
  142. </strong></a><dd>Enables logging of debugging information.
  143.  
  144. <dt><a name="_help_h_"><strong><p>--help, -h, -?
  145.  
  146. </strong></a><dd>These are all equivalent to <code>vcp help</code>.
  147.  
  148. <dt><a name="_output_config_file_filename_"><strong><p>--output-config-file=$filename
  149.  
  150. </strong></a><dd>Write the settings (parsed from the UI, the command line, or a config
  151. file to a file.  Useful for capturing settings or user interface output.
  152. Does not affect running.  Use &quot;-&quot; to emit to STDOUT.
  153.  
  154. <p><b>NOTE 1</b>: This does <i>not</i> emit an &quot;Options:&quot; section containing global
  155. options (those listed here).  Almost all of these options are not useful
  156. to emit; we can add an option to force their emission if need be.
  157.  
  158. <p><b>NOTE 2</b>: When using the interactive user interface, this option takes
  159. effect after the last interactive portion and, if vcp goes on to run a
  160. conversion, before any conversion is run.  This occurs in addition to
  161. any configuration files the user may ask the interactive interface to
  162. write.  This may change in the future (for instance, if the interactive
  163. dialog includes an option to extract and analyze metadata).  
  164.  
  165. <dt><a name="_dont_convert_"><strong><p>--dont-convert
  166.  
  167. </strong></a><dd>Do not run a conversion.  Useful when you just want to emit a .vcp file.
  168.  
  169. <dt><a name="_versions_"><strong><p>--versions
  170.  
  171. </strong></a><dd>Emits the version numbers of bundled files.
  172.  
  173. <dt><a name="_terse_t_"><strong><p>--terse, -t
  174.  
  175. </strong></a><dd>Suppress verbose explanations when running the interactive UI.  Has
  176. no effect on operation if all settings are read from the command line
  177. or a .vcp file.
  178.  
  179. </dl><h2><a name="Getting_help">Getting help
  180.  
  181. </a></h2><p>(See also <a href="#Generating_HTML_Documentation">Generating HTML Documentation</a>,
  182. below).
  183.  
  184. <p>There is a slightly different command line format for requesting help:
  185.  
  186. <pre>   vcp help [&lt;topic&gt;]
  187.  
  188. </pre><p>where <code>&lt;topic&gt;</code> is the optional name of a topic.  <code>vcp help</code> without
  189. a <code>&lt;</code>topic<code>&gt;</code> prints out a list of topics, and <code>vcp help vcp</code>
  190. emits this page.
  191.  
  192. <p>All help documents are also available as Unix <code>man</code> pages and using the
  193. <code>perldoc</code> command, although the names are slightly different:
  194.  
  195. <pre>   with vcp               via perldoc        
  196.    ================       ===========
  197.    vcp help vcp           perldoc vcp
  198.    vcp help source::cvs   perldoc VCP::Source::cvs
  199.    vcp help source::cvs   perldoc VCP::Dest::p4
  200.  
  201. </pre><p><code>vcp help</code> is case insensitive, <code>perldoc</code> and <code>man</code> may or may not be
  202. depending on your filesystem.  The <code>man</code> commands look just like the example
  203. <code>perldoc</code> commands except for the command name.  Both have the advantage that
  204. they use your system's configured pager if possible.
  205.  
  206. <h2><a name="Environment_Variables">Environment Variables
  207.  
  208. </a></h2><p>The environment is often used to set context for the source and
  209. destination by way of variables like P4USER, P4CLIENT, CVSROOT, etc.
  210.  
  211. <dl><dt><a name="VCPDEBUG_"><strong><p>VCPDEBUG
  212.  
  213. </strong></a><dd>The VCPDEBUG variable acts just like <code>-d=$VCPDEBUG</code> was present on the
  214. command line:
  215.  
  216. <pre>   VCPDEBUG=1
  217.  
  218. </pre><p>(see <a href="#_debug_d">&quot;--debug, -d&quot;</a> for more info).  This is useful when VCP is
  219. embedded in another application, like a makefile or a test suite.
  220.  
  221. </dl><p><hr><h1><a name="SEE_ALSO">SEE ALSO
  222.  
  223. </a></h1><p><a>VCP::Process</a>, <a>VCP::Newlines</a>, <a href="VCP/Source/p4.html">VCP::Source::p4</a>, <a href="VCP/Dest/p4.html">VCP::Dest::p4</a>,
  224. <a href="VCP/Source/cvs.html">VCP::Source::cvs</a>, <a href="VCP/Dest/cvs.html">VCP::Dest::cvs</a>, <a href="VCP/Source/revml.html">VCP::Source::revml</a>,
  225. <a href="VCP/Dest/revml.html">VCP::Dest::revml</a>, <a>VCP::Newlines</a>.  All are also available using <code>vcp
  226. help</code>.
  227.  
  228. <p><hr><h1><a name="AUTHOR">AUTHOR
  229.  
  230. </a></h1><p>Barrie Slaymaker &lt;barries@slaysys.com&gt;
  231.  
  232. <p><hr><h1><a name="COPYRIGHT">COPYRIGHT
  233.  
  234. </a></h1><p>Copyright (c) 2000, 2001, 2002 Perforce Software, Inc.
  235. All rights reserved.
  236.  
  237. <p>See <a>VCP::License</a> (<code>vcp help license</code>) for the terms of use.
  238.  
  239. <p><hr><i><font size="-1">Last updated: Thu Jul 15 01:02:38 2004</font></i></body></html>
# Change User Description Committed
#1 6118 Dimitry Andric Integ from //public/revml to //guest/dimitry_andric/revml/main. 17 years ago
//guest/perforce_software/revml/product/release/0.90/html/vcp.html
#1 4344 alan_teague Revised productization files updating to latest perl modules and
normalizing scripts to w...ork on both linux and bsd platforms. «		 21 years ago