Helix SwarmHelix Swarm
Loading...

vcp.html

  • //
  • guest/
  • dimitry_andric/
  • revml/
  • main/
  • docs/
  • 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>   vcp [vcp_opts] &lt;source&gt; &lt;dest&gt;
  8.  
  9. </pre><pre>   vcp help [topic]
  10.  
  11. </pre><pre>   vcp html &lt;destination dir&gt;
  12.  
  13. </pre><p><hr><h1><a name="DESCRIPTION">DESCRIPTION
  14.  
  15. </a></h1><p><code>vcp</code> ('version copy') copies versions of files from one repository to another,
  16. translating as much metadata as possible along the way.  This allows you to
  17. copy and translate files and their histories between revision storage systems.
  18.  
  19. <p>Supported source and destination types are <code>cvs:</code>, <code>p4:</code>, and <code>revml:</code>.
  20.  
  21. <h2><a name="Copying_Versions">Copying Versions
  22.  
  23. </a></h2><p>The general syntax of the vcp command line is:
  24.  
  25. <pre>   vcp [&lt;vcp options&gt;] &lt;source&gt; &lt;dest&gt;
  26.  
  27. </pre><p>The three portions of the command line are:
  28.  
  29. <dl><dt><a name="_vcp_options_"><strong><p><code>&lt;vcp options&gt;</code>
  30.  
  31. </strong></a><dd>Command line options that control the operation of the <code>vcp</code> command, like
  32. <code>-d</code> for debugging or <code>-h</code> for help.  There are very few global options,
  33. these are covered below. Note that they must come before the
  34. <code>&lt;source&gt;</code> specification.
  35.  
  36. <dt><a name="_source_"><strong><p><code>&lt;source&gt;</code>
  37.  
  38. </strong></a><dd>Were to extract versions from, including any command line options needed to
  39. control what is extracted and how.  See the next section.
  40.  
  41. <dt><a name="_dest_"><strong><p><code>&lt;dest&gt;</code>
  42.  
  43. </strong></a><dd>Where to insert versions, including any command line options needed to control
  44. how files are stored.  See the next section.
  45.  
  46. </dl><h2><a name="Specifying_Repositories">Specifying Repositories
  47.  
  48. </a></h2><p>The <code>&lt;source&gt;</code> and <code>&lt;dest&gt;</code> specifications specify a
  49. repository and provide any options needed for accessing that repository.
  50.  
  51. <p>These spefications may be a simple filename for reading or writing RevML
  52. files (if the requisite XML handling modules are installed). or a full
  53. repository specification like <code>cvs:/home/cvs/root:module</code> or
  54. <code>p4:user:password@server:port://depot/dir</code>.
  55.  
  56. <p>When using the long form to access a repository, <code>&lt;source&gt;</code> and
  57. <code>&lt;dest&gt;</code> specification have several fields delimited by <code>:</code>
  58. and <code>@</code>, and may have trailing command line options.  The full (rarely
  59. used) syntax is:
  60.  
  61. <pre>   scheme:user(view):password@repository:filespec [&lt;options&gt;]
  62.  
  63. </pre><p>where
  64.  
  65. <dl><dt><a name="scheme_"><strong><p><code>scheme:</code>
  66.  
  67. </strong></a><dd>The repository type (<code>p4:</code>, <code>cvs:</code>, <code>revml:</code>).
  68.  
  69. <dt><a name="user"><strong><p><code>user</code>, <code>view</code>, and <code>password</code>
  70.  
  71. </strong></a><dd>Optional values for authenticating with the repository and identifying which
  72. view to use.  <code>cvs</code> does not use <code>view</code>.  For <code>p4</code>, <code>view</code> is the client
  73. setting (equibalent to setting <code>P4CLIENT</code> or using <code>p4</code>'s <code>-c</code> option).
  74.  
  75. <dt><a name="repository"><strong><p><code>repository</code>
  76.  
  77. </strong></a><dd>The repository spec, CVSROOT for CVS or P4PORT for p4.
  78.  
  79. <dt><a name="filespec"><strong><p><code>filespec</code>
  80.  
  81. </strong></a><dd>Which versions of what files to move.  As much as possible, this spec is
  82. similar to the native filespecs used by the repository indicated by the scheme.
  83.  
  84. <dt><a name="_options_"><strong><p><code>&lt;options&gt;</code>
  85.  
  86. </strong></a><dd>Command line options that usually mimic the options provided by the underlying
  87. repositories' command line tools (<code>cvs</code>, <code>p4</code>, etc).
  88.  
  89. </dl><p>Most of these fields are omitted in practice, only the <code>scheme</code> field is
  90. required, though (in most cases) the <code>repository</code> field is also needed unless
  91. you set the appropriate environment variables (<code>CVSROOT</code>, <code>P4PORT</code>, etc).
  92.  
  93. <p>The a bit confusing, here are some examples specs:
  94.  
  95. <pre>   cvs:server:/foo
  96.    p4:user@server://depot/foo/...
  97.    p4:user:password@public.perforce.com:1666://depot/foo/...
  98.  
  99. </pre><p>Options and formats for of individual schemes can be found in the relevant
  100. help topics, for instance:
  101.  
  102. <pre>   vcp help source::cvs
  103.  
  104. </pre><p>See <code>vcp help</code> for a list of source and destination topics.
  105.  
  106. <p>When reading and writing RevML files, a simple filename will do
  107. (although the long form may also be used).  The special value &quot;-&quot; means
  108. to read/write stdin and stdout when used as a source or destination
  109. name, respectively.  &quot;-&quot; is assumed if a specification is not provided,
  110. so these invocations all accomplish the same thing, reading and writing
  111. RevML:
  112.  
  113. <pre>   vcp
  114.    vcp -
  115.    vcp revml:-
  116.    vcp revml:
  117.    vcp - -
  118.    vcp - revml:-
  119.    vcp - revml:
  120.    vcp revml:- revml:-
  121.    vcp revml: revml:
  122.  
  123. </pre><h2><a name="vcp_Options"><code>vcp</code> Options
  124.  
  125. </a></h2><p>All general options to vcp must precede the <code>&lt;source&gt;</code>.
  126. Scheme-specific options must be placed immediately after the
  127. <code>&lt;source&gt;</code> or <code>&lt;dest&gt;</code> spec and before the next one.
  128.  
  129. <dl><dt><a name="_debug_spec_d_spec_"><strong><p>--debug &lt;spec&gt;, -d &lt;spec&gt;
  130.  
  131. </strong></a><dd>Enables display of debugging information.  A debug spec is part or all of a
  132. module name like <code>Source::revml</code> or a perl5 regular expression to match module
  133. names.  Debug specs are not case insensitively.
  134.  
  135. <p>The most general, show-me-everything debug option is:
  136.  
  137. <pre>   -d &quot;.*&quot;
  138.  
  139. </pre><p>The quotations are needed to slip the &quot;.*&quot; past most command shells.
  140.  
  141. <p>Any debug specs that don't match anything during a run are printed out
  142. when vcp exits in order to help identify mispelled patterns.  vcp will also list
  143. all of the internal names that didn't match during a run to
  144. give clues as to what specs might be useful.
  145.  
  146. <p>The special name 'what' is guaranteed to not match anything, so you can
  147. do
  148.  
  149. <pre>   vcp -d what ...
  150.  
  151. </pre><p>to see the list of names that might be useful for the arguments '...' .
  152.  
  153. <p>You may use multiple
  154. <code>-d</code> options or provide a comma separated list to enable debugging
  155. within that module. Do not start a pattern with a &quot;-&quot;.
  156.  
  157. <p>Debugging messages are emitted to stderr. See <a href="#VCPDEBUG">/VCPDEBUG</a> for how to specify
  158. debug options in the environment.
  159.  
  160. <dt><a name="_help_h_"><strong><p>--help, -h, -?
  161.  
  162. </strong></a><dd>These are all equivalent to <code>vcp help</code>.
  163.  
  164. </dl><h2><a name="Getting_help">Getting help
  165.  
  166. </a></h2><p>(See also <a href="#Generating_HTML_Documentation">Generating HTML Documentation</a>,
  167. below).
  168.  
  169. <p>There is a slightly different command line format for requesting help:
  170.  
  171. <pre>   vcp help [&lt;topic&gt;]
  172.  
  173. </pre><p>where <code>&lt;topic&gt;</code> is the optional name of a topic.  <code>vcp help</code> without
  174. a <code>&lt;</code>topic<code>&gt;</code> prints out a list of topics, and <code>vcp help vcp</code>
  175. emits this page.
  176.  
  177. <p>All help documents are also available as Unix <code>man</code> pages and using the
  178. <code>perldoc</code> command, although the names are slightly different:
  179.  
  180. <pre>   with vcp               via perldoc        
  181.    ================       ===========
  182.    vcp help vcp           perldoc vcp
  183.    vcp help source::cvs   perldoc VCP::Source::cvs
  184.    vcp help source::cvs   perldoc VCP::Dest::p4
  185.  
  186. </pre><p><code>vcp help</code> is case insensitive, <code>perldoc</code> and <code>man</code> may or may not be
  187. depending on your filesystem.  The <code>man</code> commands look just like the example
  188. <code>perldoc</code> commands except for the command name.  Both have the advantage that
  189. they use your system's configured pager if possible.
  190.  
  191. <h2><a name="Environment_Variables">Environment Variables
  192.  
  193. </a></h2><dl><dt><a name="VCPDEBUG_"><strong><p>VCPDEBUG
  194.  
  195. </strong></a><dd>The environment is often used to set context for the source and destination
  196. by way of variables like P4USER, P4CLIENT, CVSROOT, etc.
  197.  
  198. <p>There is also one environment variable that is used to enable
  199. command line debugging.  The VCPDEBUG variable acts just like a leading
  200. <code>-d=$VCPDEBUG</code> was present on the command line.
  201.  
  202. <pre>   VCPDEBUG=main,p4
  203.  
  204. </pre><p>(see <a href="#_debug_spec_d_spec_">&quot;--debug &lt;spec&gt;, -d &lt;spec&gt;&quot;</a> for more info).  This is useful when VCP is
  205. embedded in another application, like a makefile or a test suite.
  206.  
  207. </dl><h2><a name="Generating_HTML_Documentation">Generating HTML Documentation
  208.  
  209. </a></h2><p>All of the help pages in <code>vcp</code> can be built in to an HTML tree with the
  210. command:
  211.  
  212. <pre>   vcp html &lt;dest_dir&gt;
  213.  
  214. </pre><p>The index file will be <code>&lt;dest_dir&gt;/index.html</code>.
  215.  
  216. <p><hr><h1><a name="SEE_ALSO">SEE ALSO
  217.  
  218. </a></h1><p><a href="VCP/Process.html">VCP::Process</a>, <a href="VCP/Newlines.html">VCP::Newlines</a>, <a href="VCP/Source/p4.html">VCP::Source::p4</a>, <a href="VCP/Dest/p4.html">VCP::Dest::p4</a>,
  219. <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>,
  220. <a href="VCP/Dest/revml.html">VCP::Dest::revml</a>, <a href="VCP/Newlines.html">VCP::Newlines</a>.  All are also available using <code>vcp
  221. help</code>.
  222.  
  223. <p><hr><h1><a name="AUTHOR">AUTHOR
  224.  
  225. </a></h1><p>Barrie Slaymaker &lt;barries@slaysys.com&gt;
  226.  
  227. <p><hr><h1><a name="COPYRIGHT">COPYRIGHT
  228.  
  229. </a></h1><p>Copyright (c) 2000, 2001, 2002 Perforce Software, Inc.
  230. All rights reserved.
  231.  
  232. <p>See <a href="VCP/License.html">VCP::License</a> (<code>vcp help license</code>) for the terms of use.
  233.  
  234. <p><hr><i><font size="-1">Last updated: Fri Nov  8 13:07:22 2002</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/docs/html/vcp.html
#2 2307 Barrie Slaymaker get VCP::Filter::map working, update docs 22 years ago
#1 1993 Barrie Slaymaker Check in HTML documentation 23 years ago