1<div id="checkout-options"></div>
2<div class="header">
3<p>
4Next: [[cvs: checkout examples#checkout examples|checkout examples]], Up: [[cvs: checkout--Check out sources for editing#checkout&mdash;Check out sources for editing|checkout]] &nbsp; |[[cvs: Index#SEC_Contents|Contents]]||[[cvs: Index#Index|Index]]|</p>
5</div>
6
7----
8
9<div id="checkout-options-1"></div>
10==== checkout options ====
11
12These standard options are supported by <code>checkout</code>
13(see [[cvs: Common command options#Common command options|Common options]], for a complete description of
14them):
15
16;<code>-D <var>date</var></code>
17: Use the most recent revision no later than <var>date</var>. This option is sticky, and implies &lsquo;<code>-P</code>&rsquo;.  See [[cvs: Sticky tags#Sticky tags|Sticky tags]], for more information on sticky tags/dates.
18
19;<code>-f</code>
20: Only useful with the &lsquo;<code>-D <var>date</var></code>&rsquo; or &lsquo;<code>-r <var>tag</var></code>&rsquo; flags.  If no matching revision is found, retrieve the most recent revision (instead of ignoring the file).
21
22;<code>-k <var>kflag</var></code>
23: Process keywords according to <var>kflag</var>.  See [[cvs: Keyword substitution#Keyword substitution|Keyword substitution]]. This option is sticky; future updates of this file in this working directory will use the same <var>kflag</var>.  The <code>status</code> command can be viewed to see the sticky options.  See [[cvs: Quick reference to CVS commands#Quick reference to CVS commands|Invoking CVS]], for more information on the <code>status</code> command.
24
25;<code>-l</code>
26: Local; run only in current working directory.
27
28;<code>-n</code>
29: Do not run any checkout program (as specified with the &lsquo;<code>-o</code>&rsquo; option in the modules file; see [[cvs: The modules file#The modules file|modules]]).
30
31;<code>-P</code>
32: Prune empty directories.  See [[cvs: Moving and renaming directories#Moving and renaming directories|Moving directories]].
33
34;<code>-p</code>
35: Pipe files to the standard output.
36
37;<code>-R</code>
38: Checkout directories recursively.  This option is on by default.
39
40;<code>-r <var>tag</var></code>
41: Use revision <var>tag</var>.  This option is sticky, and implies &lsquo;<code>-P</code>&rsquo;. See [[cvs: Sticky tags#Sticky tags|Sticky tags]], for more information on sticky tags/dates.
42
43In addition to those, you can use these special command
44options with <code>checkout</code>:
45
46;<code>-A</code>
47: Reset any sticky tags, dates, or &lsquo;<code>-k</code>&rsquo; options. See [[cvs: Sticky tags#Sticky tags|Sticky tags]], for more information on sticky tags/dates.
48
49;<code>-c</code>
50: Copy the module file, sorted, to the standard output, instead of creating or modifying any files or directories in your working directory.
51
52;<code>-d <var>dir</var></code>
53: Create a directory called <var>dir</var> for the working files, instead of using the module name.  In general, using this flag is equivalent to using &lsquo;<code>mkdir <var>dir</var>; cd <var>dir</var></code>&rsquo; followed by the checkout command without the &lsquo;<code>-d</code>&rsquo; flag.
54
55: There is an important exception, however.  It is very convenient when checking out a single item to have the output appear in a directory that doesn&rsquo;t contain empty intermediate directories.  In this case ''only'', <small>CVS</small> tries to &ldquo;shorten&rdquo; pathnames to avoid those empty directories.
56
57: For example, given a module &lsquo;<code>foo</code>&rsquo; that contains the file &lsquo;<code>bar.c</code>&rsquo;, the command &lsquo;<code>cvs co -d dir foo</code>&rsquo; will create directory &lsquo;<code>dir</code>&rsquo; and place &lsquo;<code>bar.c</code>&rsquo; inside.  Similarly, given a module &lsquo;<code>bar</code>&rsquo; which has subdirectory &lsquo;<code>baz</code>&rsquo; wherein there is a file &lsquo;<code>quux.c</code>&rsquo;, the command &lsquo;<code>cvs co -d dir bar/baz</code>&rsquo; will create directory &lsquo;<code>dir</code>&rsquo; and place &lsquo;<code>quux.c</code>&rsquo; inside.
58
59: Using the &lsquo;<code>-N</code>&rsquo; flag will defeat this behavior. Given the same module definitions above, &lsquo;<code>cvs co -N -d dir foo</code>&rsquo; will create directories &lsquo;<code>dir/foo</code>&rsquo; and place &lsquo;<code>bar.c</code>&rsquo; inside, while &lsquo;<code>cvs co -N -d dir bar/baz</code>&rsquo; will create directories &lsquo;<code>dir/bar/baz</code>&rsquo; and place &lsquo;<code>quux.c</code>&rsquo; inside.
60
61;<code>-j <var>tag</var></code>
62: With two &lsquo;<code>-j</code>&rsquo; options, merge changes from the revision specified with the first &lsquo;<code>-j</code>&rsquo; option to the revision specified with the second &lsquo;<code>j</code>&rsquo; option, into the working directory.
63
64: With one &lsquo;<code>-j</code>&rsquo; option, merge changes from the ancestor revision to the revision specified with the &lsquo;<code>-j</code>&rsquo; option, into the working directory.  The ancestor revision is the common ancestor of the revision which the working directory is based on, and the revision specified in the &lsquo;<code>-j</code>&rsquo; option.
65
66: In addition, each -j option can contain an optional date specification which, when used with branches, can limit the chosen revision to one within a specific date.  An optional date is specified by adding a colon (:) to the tag: &lsquo;<code>-j<var>Symbolic_Tag</var>:<var>Date_Specifier</var></code>&rsquo;.
67
68: See [[cvs: Branching and merging#Branching and merging|Branching and merging]].
69
70;<code>-N</code>
71: Only useful together with &lsquo;<code>-d <var>dir</var></code>&rsquo;.  With this option, <small>CVS</small> will not &ldquo;shorten&rdquo; module paths in your working directory when you check out a single module.  See the &lsquo;<code>-d</code>&rsquo; flag for examples and a discussion.
72
73;<code>-s</code>
74: Like &lsquo;<code>-c</code>&rsquo;, but include the status of all modules, and sort it by the status string.  See [[cvs: The modules file#The modules file|modules]], for info about the &lsquo;<code>-s</code>&rsquo; option that is used inside the modules file to set the module status.
75
76
77----
78
79<div class="header">
80<p>
81Next: [[cvs: checkout examples#checkout examples|checkout examples]], Up: [[cvs: checkout--Check out sources for editing#checkout&mdash;Check out sources for editing|checkout]] &nbsp; |[[cvs: Index#SEC_Contents|Contents]]||[[cvs: Index#Index|Index]]|</p>
82</div>
83This document was generated on <i>a sunny day</i> using [http://www.nongnu.org/texi2html/ <i>texi2html</i>].
84