/contrib/cvs/doc/cvs.1

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 3968 lines · 3937 code · 31 blank · 0 comment · 0 complexity · 67448ebcc103d7fe3cc0c5d37422628d MD5 · raw file

Large files are truncated click here to view the full file

  1. .\" This is the man page for CVS. It is auto-generated from the
  2. .\" cvs.man.header, cvs.texinfo, & cvs.man.footer files. Please make changes
  3. .\" there. A full copyright & license notice may also be found in cvs.texinfo.
  4. .\"
  5. .\" Man page autogeneration, including this header file, is
  6. .\" Copyright 2004-2005 The Free Software Foundation, Inc.,
  7. .\" Derek R. Price, & Ximbiot <http://ximbiot.com>.
  8. .\"
  9. .\" This documentation is free software; you can redistribute it and/or modify
  10. .\" it under the terms of the GNU General Public License as published by
  11. .\" the Free Software Foundation; either version 2, or (at your option)
  12. .\" any later version.
  13. .\"
  14. .\" This documentation is distributed in the hope that it will be useful,
  15. .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. .\" GNU General Public License for more details.
  18. .\"
  19. .\" You should have received a copy of the GNU General Public License
  20. .\" along with this documentation; if not, write to the Free Software
  21. .\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  22. .de Id
  23. .ds Rv \\$3
  24. .ds Dt \\$4
  25. ..
  26. .TH CVS 1 "\*(Dt"
  27. .\" Full space in nroff; half space in troff
  28. .de SP
  29. .if n .sp
  30. .if t .sp .5
  31. ..
  32. .\" quoted command
  33. .de `
  34. .RB ` "\|\\$1\|" '\\$2
  35. ..
  36. .SH "NAME"
  37. cvs \- Concurrent Versions System
  38. .SH "SYNOPSIS"
  39. .TP
  40. \fBcvs\fP [ \fIcvs_options\fP ]
  41. .I cvs_command
  42. [
  43. .I command_options
  44. ] [
  45. .I command_args
  46. ]
  47. .SH "NOTE"
  48. .IX "revision control system" "\fLcvs\fR"
  49. .IX cvs "" "\fLcvs\fP \- concurrent versions system"
  50. .IX "concurrent versions system \- \fLcvs\fP"
  51. .IX "release control system" "cvs command" "" "\fLcvs\fP \- concurrent versions system"
  52. .IX "source control system" "cvs command" "" "\fLcvs\fP \- concurrent versions system"
  53. .IX revisions "cvs command" "" "\fLcvs\fP \- source control"
  54. This manpage is a summary of some of the features of
  55. \fBcvs\fP. It is auto-generated from an appendix of the CVS manual.
  56. For more in-depth documentation, please consult the
  57. Cederqvist manual (via the
  58. .B info CVS
  59. command or otherwise,
  60. as described in the SEE ALSO section of this manpage). Cross-references
  61. in this man page refer to nodes in the same.
  62. .SH "CVS commands"
  63. .SS "Guide to CVS commands"
  64. .SP
  65. This appendix describes the overall structure of
  66. \fBcvs\fR commands, and describes some commands in
  67. detail (others are described elsewhere; for a quick
  68. reference to \fBcvs\fR commands, see node `Invoking CVS\(aq in the CVS manual).
  69. .SP
  70. .SH "Structure"
  71. .SS "Overall structure of CVS commands"
  72. .IX "Structure"
  73. .IX "CVS command structure"
  74. .IX "Command structure"
  75. .IX "Format of CVS commands"
  76. .SP
  77. The overall format of all \fBcvs\fR commands is:
  78. .SP
  79. .PD 0
  80. .SP
  81. .IP "" 2
  82. cvs [ cvs_options ] cvs_command [ command_options ] [ command_args ]
  83. .PD
  84. .IP "" 0
  85. .SP
  86. .IP "" 0
  87. \fBcvs\fR
  88. .IP "" 2
  89. The name of the \fBcvs\fR program.
  90. .SP
  91. .IP "" 0
  92. \fBcvs_options\fR
  93. .IP "" 2
  94. Some options that affect all sub-commands of \fBcvs\fR. These are
  95. described below.
  96. .SP
  97. .IP "" 0
  98. \fBcvs_command\fR
  99. .IP "" 2
  100. One of several different sub-commands. Some of the commands have
  101. aliases that can be used instead; those aliases are noted in the
  102. reference manual for that command. There are only two situations
  103. where you may omit \fBcvs_command\fR: \fBcvs -H\fR elicits a
  104. list of available commands, and \fBcvs -v\fR displays version
  105. information on \fBcvs\fR itself.
  106. .SP
  107. .IP "" 0
  108. \fBcommand_options\fR
  109. .IP "" 2
  110. Options that are specific for the command.
  111. .SP
  112. .IP "" 0
  113. \fBcommand_args\fR
  114. .IP "" 2
  115. Arguments to the commands.
  116. .SP
  117. There is unfortunately some confusion between
  118. \fBcvs_options\fR and \fBcommand_options\fR.
  119. When given as a \fBcvs_option\fR, some options only
  120. affect some of the commands. When given as a
  121. \fBcommand_option\fR it may have a different meaning, and
  122. be accepted by more commands. In other words, do not
  123. take the above categorization too seriously. Look at
  124. the documentation instead.
  125. .SP
  126. .SH "Exit status"
  127. .SS "CVS\(aqs exit status"
  128. .IX "Exit status, of CVS"
  129. .SP
  130. \fBcvs\fR can indicate to the calling environment whether it
  131. succeeded or failed by setting its \fIexit status\fR.
  132. The exact way of testing the exit status will vary from
  133. one operating system to another. For example in a unix
  134. shell script the \fB$?\fR variable will be 0 if the
  135. last command returned a successful exit status, or
  136. greater than 0 if the exit status indicated failure.
  137. .SP
  138. If \fBcvs\fR is successful, it returns a successful status;
  139. if there is an error, it prints an error message and
  140. returns a failure status. The one exception to this is
  141. the \fBcvs diff\fR command. It will return a
  142. successful status if it found no differences, or a
  143. failure status if there were differences or if there
  144. was an error. Because this behavior provides no good
  145. way to detect errors, in the future it is possible that
  146. \fBcvs diff\fR will be changed to behave like the
  147. other \fBcvs\fR commands.
  148. .SP
  149. .SH "~/.cvsrc"
  150. .SS "Default options and the ~/.cvsrc file"
  151. .IX "\&.cvsrc file"
  152. .IX "Option defaults"
  153. .SP
  154. There are some \fBcommand_options\fR that are used so
  155. often that you might have set up an alias or some other
  156. means to make sure you always specify that option. One
  157. example (the one that drove the implementation of the
  158. \fB.cvsrc\fR support, actually) is that many people find the
  159. default output of the \fBdiff\fR command to be very
  160. hard to read, and that either context diffs or unidiffs
  161. are much easier to understand.
  162. .SP
  163. The \fB~/.cvsrc\fR file is a way that you can add
  164. default options to \fBcvs_commands\fR within cvs,
  165. instead of relying on aliases or other shell scripts.
  166. .SP
  167. The format of the \fB~/.cvsrc\fR file is simple. The
  168. file is searched for a line that begins with the same
  169. name as the \fBcvs_command\fR being executed. If a
  170. match is found, then the remainder of the line is split
  171. up (at whitespace characters) into separate options and
  172. added to the command arguments \fIbefore\fR any
  173. options from the command line.
  174. .SP
  175. If a command has two names (e.g., \fBcheckout\fR and
  176. \fBco\fR), the official name, not necessarily the one
  177. used on the command line, will be used to match against
  178. the file. So if this is the contents of the user\(aqs
  179. \fB~/.cvsrc\fR file:
  180. .SP
  181. .PD 0
  182. .SP
  183. .IP "" 2
  184. log -N
  185. .IP "" 2
  186. diff -uN
  187. .IP "" 2
  188. rdiff -u
  189. .IP "" 2
  190. update -Pd
  191. .IP "" 2
  192. checkout -P
  193. .IP "" 2
  194. release -d
  195. .PD
  196. .IP "" 0
  197. .SP
  198. the command \fBcvs checkout foo\fR would have the
  199. \fB-P\fR option added to the arguments, as well as
  200. \fBcvs co foo\fR.
  201. .SP
  202. With the example file above, the output from \fBcvs
  203. diff foobar\fR will be in unidiff format. \fBcvs diff
  204. -c foobar\fR will provide context diffs, as usual.
  205. Getting "old" format diffs would be slightly more
  206. complicated, because \fBdiff\fR doesn\(aqt have an option
  207. to specify use of the "old" format, so you would need
  208. \fBcvs -f diff foobar\fR.
  209. .SP
  210. In place of the command name you can use \fBcvs\fR to
  211. specify global options (see node `Global options\(aq in the CVS manual). For
  212. example the following line in \fB.cvsrc\fR
  213. .SP
  214. .PD 0
  215. .SP
  216. .IP "" 2
  217. cvs -z6
  218. .PD
  219. .IP "" 0
  220. .SP
  221. causes \fBcvs\fR to use compression level 6.
  222. .SP
  223. .SH "Global options"
  224. .IX "Options, global"
  225. .IX "Global options"
  226. .IX "Left-hand options"
  227. .SP
  228. The available \fBcvs_options\fR (that are given to the
  229. left of \fBcvs_command\fR) are:
  230. .SP
  231. .IP "" 0
  232. \fB--allow-root=\fIrootdir\fB\fR
  233. .IP "" 2
  234. Specify legal \fBcvsroot\fR directory. See
  235. `Password authentication server\(aq in the CVS manual.
  236. .SP
  237. .IX "Authentication, stream"
  238. .IX "Stream authentication"
  239. .IP "" 0
  240. \fB-a\fR
  241. .IP "" 2
  242. Authenticate all communication between the client and
  243. the server. Only has an effect on the \fBcvs\fR client.
  244. As of this writing, this is only implemented when using
  245. a GSSAPI connection (see node `GSSAPI authenticated\(aq in the CVS manual).
  246. Authentication prevents certain sorts of attacks
  247. involving hijacking the active \fBtcp\fR connection.
  248. Enabling authentication does not enable encryption.
  249. .SP
  250. .IX "RCSBIN, overriding"
  251. .IX "Overriding RCSBIN"
  252. .IP "" 0
  253. \fB-b \fIbindir\fB\fR
  254. .IP "" 2
  255. In \fBcvs\fR 1.9.18 and older, this specified that
  256. \fBrcs\fR programs are in the \fIbindir\fR directory.
  257. Current versions of \fBcvs\fR do not run \fBrcs\fR
  258. programs; for compatibility this option is accepted,
  259. but it does nothing.
  260. .SP
  261. .IX "TMPDIR, overriding"
  262. .IX "Overriding TMPDIR"
  263. .IP "" 0
  264. \fB-T \fItempdir\fB\fR
  265. .IP "" 2
  266. Use \fItempdir\fR as the directory where temporary files are
  267. located. Overrides the setting of the \fB$TMPDIR\fR environment
  268. variable and any precompiled directory. This parameter should be
  269. specified as an absolute pathname.
  270. (When running client/server, \fB-T\fR affects only the local process;
  271. specifying \fB-T\fR for the client has no effect on the server and
  272. vice versa.)
  273. .SP
  274. .IX "CVSROOT, overriding"
  275. .IX "Overriding CVSROOT"
  276. .IP "" 0
  277. \fB-d \fIcvs_root_directory\fB\fR
  278. .IP "" 2
  279. Use \fIcvs_root_directory\fR as the root directory
  280. pathname of the repository. Overrides the setting of
  281. the \fB$CVSROOT\fR environment variable. See `Repository\(aq in the CVS manual.
  282. .SP
  283. .IX "EDITOR, overriding"
  284. .IX "Overriding EDITOR"
  285. .IP "" 0
  286. \fB-e \fIeditor\fB\fR
  287. .IP "" 2
  288. Use \fIeditor\fR to enter revision log information. Overrides the
  289. setting of the \fB$CVSEDITOR\fR and \fB$EDITOR\fR
  290. environment variables. For more information, see
  291. `Committing your changes\(aq in the CVS manual.
  292. .SP
  293. .IP "" 0
  294. \fB-f\fR
  295. .IP "" 2
  296. Do not read the \fB~/.cvsrc\fR file. This
  297. option is most often used because of the
  298. non-orthogonality of the \fBcvs\fR option set. For
  299. example, the \fBcvs log\fR option \fB-N\fR (turn off
  300. display of tag names) does not have a corresponding
  301. option to turn the display on. So if you have
  302. \fB-N\fR in the \fB~/.cvsrc\fR entry for \fBlog\fR,
  303. you may need to use \fB-f\fR to show the tag names.
  304. .SP
  305. .IP "" 0
  306. \fB-H\fR
  307. .IP "" 2
  308. .IP "" 0
  309. \fB--help\fR
  310. .IP "" 2
  311. Display usage information about the specified \fBcvs_command\fR
  312. (but do not actually execute the command). If you don\(aqt specify
  313. a command name, \fBcvs -H\fR displays overall help for
  314. \fBcvs\fR, including a list of other help options.
  315. .SP
  316. .IX "Read-only mode"
  317. .IP "" 0
  318. \fB-n\fR
  319. .IP "" 2
  320. Do not change any files. Attempt to execute the
  321. \fBcvs_command\fR, but only to issue reports; do not remove,
  322. update, or merge any existing files, or create any new files.
  323. .SP
  324. Note that \fBcvs\fR will not necessarily produce exactly
  325. the same output as without \fB-n\fR. In some cases
  326. the output will be the same, but in other cases
  327. \fBcvs\fR will skip some of the processing that would
  328. have been required to produce the exact same output.
  329. .SP
  330. .IP "" 0
  331. \fB-Q\fR
  332. .IP "" 2
  333. Cause the command to be really quiet; the command will only
  334. generate output for serious problems.
  335. .SP
  336. .IP "" 0
  337. \fB-q\fR
  338. .IP "" 2
  339. Cause the command to be somewhat quiet; informational messages,
  340. such as reports of recursion through subdirectories, are
  341. suppressed.
  342. .SP
  343. .IX "Read-only files, and -r"
  344. .IP "" 0
  345. \fB-r\fR
  346. .IP "" 2
  347. Make new working files read-only. Same effect
  348. as if the \fB$CVSREAD\fR environment variable is set
  349. (see node `Environment variables\(aq in the CVS manual). The default is to
  350. make working files writable, unless watches are on
  351. (see node `Watches\(aq in the CVS manual).
  352. .SP
  353. .IP "" 0
  354. \fB-s \fIvariable\fB=\fIvalue\fB\fR
  355. .IP "" 2
  356. Set a user variable (see node `Variables\(aq in the CVS manual).
  357. .SP
  358. .IX "Trace"
  359. .IP "" 0
  360. \fB-t\fR
  361. .IP "" 2
  362. Trace program execution; display messages showing the steps of
  363. \fBcvs\fR activity. Particularly useful with \fB-n\fR to explore the
  364. potential impact of an unfamiliar command.
  365. .SP
  366. .IP "" 0
  367. \fB-v\fR
  368. .IP "" 2
  369. .IP "" 0
  370. \fB--version\fR
  371. .IP "" 2
  372. Display version and copyright information for \fBcvs\fR.
  373. .SP
  374. .IX "CVSREAD, overriding"
  375. .IX "Overriding CVSREAD"
  376. .IP "" 0
  377. \fB-w\fR
  378. .IP "" 2
  379. Make new working files read-write. Overrides the
  380. setting of the \fB$CVSREAD\fR environment variable.
  381. Files are created read-write by default, unless \fB$CVSREAD\fR is
  382. set or \fB-r\fR is given.
  383. .SP
  384. .IP "" 0
  385. \fB-x\fR
  386. .IP "" 2
  387. .IX "Encryption"
  388. Encrypt all communication between the client and the
  389. server. Only has an effect on the \fBcvs\fR client. As
  390. of this writing, this is only implemented when using a
  391. GSSAPI connection (see node `GSSAPI authenticated\(aq in the CVS manual) or a
  392. Kerberos connection (see node `Kerberos authenticated\(aq in the CVS manual).
  393. Enabling encryption implies that message traffic is
  394. also authenticated. Encryption support is not
  395. available by default; it must be enabled using a
  396. special configure option, \fB--enable-encryption\fR,
  397. when you build \fBcvs\fR.
  398. .SP
  399. .IP "" 0
  400. \fB-z \fIgzip-level\fB\fR
  401. .IP "" 2
  402. .IX "Compression"
  403. .IX "Gzip"
  404. Set the compression level.
  405. Valid levels are 1 (high speed, low compression) to
  406. 9 (low speed, high compression), or 0 to disable
  407. compression (the default).
  408. Only has an effect on the \fBcvs\fR client.
  409. .SP
  410. .SP
  411. .SH "Common options"
  412. .SS "Common command options"
  413. .IX "Common options"
  414. .IX "Right-hand options"
  415. .SP
  416. This section describes the \fBcommand_options\fR that
  417. are available across several \fBcvs\fR commands. These
  418. options are always given to the right of
  419. \fBcvs_command\fR. Not all
  420. commands support all of these options; each option is
  421. only supported for commands where it makes sense.
  422. However, when a command has one of these options you
  423. can almost always count on the same behavior of the
  424. option as in other commands. (Other command options,
  425. which are listed with the individual commands, may have
  426. different behavior from one \fBcvs\fR command to the other).
  427. .SP
  428. \fBThe \fBhistory\fB command is an exception; it supports
  429. many options that conflict even with these standard options.\fR
  430. .SP
  431. .IX "Dates"
  432. .IX "Time"
  433. .IX "Specifying dates"
  434. .IP "" 0
  435. \fB-D \fIdate_spec\fB\fR
  436. .IP "" 2
  437. Use the most recent revision no later than \fIdate_spec\fR.
  438. \fIdate_spec\fR is a single argument, a date description
  439. specifying a date in the past.
  440. .SP
  441. The specification is \fIsticky\fR when you use it to make a
  442. private copy of a source file; that is, when you get a working
  443. file using \fB-D\fR, \fBcvs\fR records the date you specified, so that
  444. further updates in the same directory will use the same date
  445. (for more information on sticky tags/dates, see node `Sticky tags\(aq in the CVS manual).
  446. .SP
  447. \fB-D\fR is available with the \fBannotate\fR, \fBcheckout\fR,
  448. \fBdiff\fR, \fBexport\fR, \fBhistory\fR,
  449. \fBrdiff\fR, \fBrtag\fR, and \fBupdate\fR commands.
  450. (The \fBhistory\fR command uses this option in a
  451. slightly different way; see node `history options\(aq in the CVS manual).
  452. .SP
  453. .IX "Timezone, in input"
  454. .IX "Zone, time, in input"
  455. A wide variety of date formats are supported by
  456. \fBcvs\fR. The most standard ones are ISO8601 (from the
  457. International Standards Organization) and the Internet
  458. e-mail standard (specified in RFC822 as amended by
  459. RFC1123).
  460. .SP
  461. ISO8601 dates have many variants but a few examples
  462. are:
  463. .SP
  464. .PD 0
  465. .SP
  466. .IP "" 4
  467. 1972-09-24
  468. .IP "" 4
  469. 1972-09-24 20:05
  470. .PD
  471. .IP "" 2
  472. .SP
  473. There are a lot more ISO8601 date formats, and \fBcvs\fR
  474. accepts many of them, but you probably don\(aqt want to
  475. hear the \fIwhole\fR long story :-).
  476. .SP
  477. In addition to the dates allowed in Internet e-mail
  478. itself, \fBcvs\fR also allows some of the fields to be
  479. omitted. For example:
  480. .SP
  481. .PD 0
  482. .SP
  483. .IP "" 4
  484. 24 Sep 1972 20:05
  485. .IP "" 4
  486. 24 Sep
  487. .PD
  488. .IP "" 2
  489. .SP
  490. The date is interpreted as being in the
  491. local timezone, unless a specific timezone is
  492. specified.
  493. .SP
  494. These two date formats are preferred. However,
  495. \fBcvs\fR currently accepts a wide variety of other date
  496. formats. They are intentionally not documented here in
  497. any detail, and future versions of \fBcvs\fR might not
  498. accept all of them.
  499. .SP
  500. One such format is
  501. \fB\fImonth\fB/\fIday\fB/\fIyear\fB\fR. This may
  502. confuse people who are accustomed to having the month
  503. and day in the other order; \fB1/4/96\fR is January 4,
  504. not April 1.
  505. .SP
  506. Remember to quote the argument to the \fB-D\fR
  507. flag so that your shell doesn\(aqt interpret spaces as
  508. argument separators. A command using the \fB-D\fR
  509. flag can look like this:
  510. .SP
  511. .PD 0
  512. .SP
  513. .IP "" 4
  514. $ cvs diff -D "1 hour ago" cvs.texinfo
  515. .PD
  516. .IP "" 2
  517. .SP
  518. .IX "Forcing a tag match"
  519. .IP "" 0
  520. \fB-f\fR
  521. .IP "" 2
  522. When you specify a particular date or tag to \fBcvs\fR commands, they
  523. normally ignore files that do not contain the tag (or did not
  524. exist prior to the date) that you specified. Use the \fB-f\fR option
  525. if you want files retrieved even when there is no match for the
  526. tag or date. (The most recent revision of the file
  527. will be used).
  528. .SP
  529. Note that even with \fB-f\fR, a tag that you specify
  530. must exist (that is, in some file, not necessary in
  531. every file). This is so that \fBcvs\fR will continue to
  532. give an error if you mistype a tag name.
  533. .SP
  534. \fB-f\fR is available with these commands:
  535. \fBannotate\fR, \fBcheckout\fR, \fBexport\fR,
  536. \fBrdiff\fR, \fBrtag\fR, and \fBupdate\fR.
  537. .SP
  538. \fBWARNING: The \fBcommit\fB and \fBremove\fB
  539. commands also have a
  540. \fB-f\fB option, but it has a different behavior for
  541. those commands. See `commit options\(aq in the CVS manual, and
  542. `Removing files\(aq in the CVS manual.\fR
  543. .SP
  544. .IP "" 0
  545. \fB-k \fIkflag\fB\fR
  546. .IP "" 2
  547. Alter the default processing of keywords.
  548. See `Keyword substitution\(aq in the CVS manual, for the meaning of
  549. \fIkflag\fR. Your \fIkflag\fR specification is
  550. \fIsticky\fR when you use it to create a private copy
  551. of a source file; that is, when you use this option
  552. with the \fBcheckout\fR or \fBupdate\fR commands,
  553. \fBcvs\fR associates your selected \fIkflag\fR with the
  554. file, and continues to use it with future update
  555. commands on the same file until you specify otherwise.
  556. .SP
  557. The \fB-k\fR option is available with the \fBadd\fR,
  558. \fBcheckout\fR, \fBdiff\fR, \fBrdiff\fR, \fBimport\fR and
  559. \fBupdate\fR commands.
  560. .SP
  561. .IP "" 0
  562. \fB-l\fR
  563. .IP "" 2
  564. Local; run only in current working directory, rather than
  565. recursing through subdirectories.
  566. .SP
  567. Available with the following commands: \fBannotate\fR, \fBcheckout\fR,
  568. \fBcommit\fR, \fBdiff\fR, \fBedit\fR, \fBeditors\fR, \fBexport\fR,
  569. \fBlog\fR, \fBrdiff\fR, \fBremove\fR, \fBrtag\fR,
  570. \fBstatus\fR, \fBtag\fR, \fBunedit\fR, \fBupdate\fR, \fBwatch\fR,
  571. and \fBwatchers\fR.
  572. .SP
  573. .IX "Editor, avoiding invocation of"
  574. .IX "Avoiding editor invocation"
  575. .IP "" 0
  576. \fB-m \fImessage\fB\fR
  577. .IP "" 2
  578. Use \fImessage\fR as log information, instead of
  579. invoking an editor.
  580. .SP
  581. Available with the following commands: \fBadd\fR,
  582. \fBcommit\fR and \fBimport\fR.
  583. .SP
  584. .IP "" 0
  585. \fB-n\fR
  586. .IP "" 2
  587. Do not run any tag program. (A program can be
  588. specified to run in the modules
  589. database (see node `modules\(aq in the CVS manual); this option bypasses it).
  590. .SP
  591. \fBThis is not the same as the \fBcvs -n\fB
  592. program option, which you can specify to the left of a cvs command!\fR
  593. .SP
  594. Available with the \fBcheckout\fR, \fBexport\fR,
  595. and \fBrtag\fR commands.
  596. .SP
  597. .IP "" 0
  598. \fB-P\fR
  599. .IP "" 2
  600. Prune empty directories. See `Removing directories\(aq in the CVS manual.
  601. .SP
  602. .IP "" 0
  603. \fB-p\fR
  604. .IP "" 2
  605. Pipe the files retrieved from the repository to standard output,
  606. rather than writing them in the current directory. Available
  607. with the \fBcheckout\fR and \fBupdate\fR commands.
  608. .SP
  609. .IP "" 0
  610. \fB-R\fR
  611. .IP "" 2
  612. Process directories recursively. This is on by default.
  613. .SP
  614. Available with the following commands: \fBannotate\fR, \fBcheckout\fR,
  615. \fBcommit\fR, \fBdiff\fR, \fBedit\fR, \fBeditors\fR, \fBexport\fR,
  616. \fBrdiff\fR, \fBremove\fR, \fBrtag\fR,
  617. \fBstatus\fR, \fBtag\fR, \fBunedit\fR, \fBupdate\fR, \fBwatch\fR,
  618. and \fBwatchers\fR.
  619. .SP
  620. .IP "" 0
  621. \fB-r \fItag\fB\fR
  622. .IP "" 2
  623. .IX "HEAD, special tag"
  624. .IX "BASE, special tag"
  625. Use the revision specified by the \fItag\fR argument instead of the
  626. default \fIhead\fR revision. As well as arbitrary tags defined
  627. with the \fBtag\fR or \fBrtag\fR command, two special tags are
  628. always available: \fBHEAD\fR refers to the most recent version
  629. available in the repository, and \fBBASE\fR refers to the
  630. revision you last checked out into the current working directory.
  631. .SP
  632. The tag specification is sticky when you use this
  633. with \fBcheckout\fR or \fBupdate\fR to make your own
  634. copy of a file: \fBcvs\fR remembers the tag and continues to use it on
  635. future update commands, until you specify otherwise (for more information
  636. on sticky tags/dates, see node `Sticky tags\(aq in the CVS manual).
  637. .SP
  638. The tag can be either a symbolic or numeric tag, as
  639. described in `Tags\(aq in the CVS manual, or the name of a branch, as
  640. described in `Branching and merging\(aq in the CVS manual.
  641. When a command expects a specific revision,
  642. the name of a branch is interpreted as the most recent
  643. revision on that branch.
  644. .SP
  645. Specifying the \fB-q\fR global option along with the
  646. \fB-r\fR command option is often useful, to suppress
  647. the warning messages when the \fBrcs\fR file
  648. does not contain the specified tag.
  649. .SP
  650. \fBThis is not the same as the overall \fBcvs -r\fB option,
  651. which you can specify to the left of a \fBcvs\fB command!\fR
  652. .SP
  653. \fB-r\fR is available with the \fBannotate\fR, \fBcheckout\fR,
  654. \fBcommit\fR, \fBdiff\fR, \fBhistory\fR, \fBexport\fR, \fBrdiff\fR,
  655. \fBrtag\fR, and \fBupdate\fR commands.
  656. .SP
  657. .IP "" 0
  658. \fB-W\fR
  659. .IP "" 2
  660. Specify file names that should be filtered. You can
  661. use this option repeatedly. The spec can be a file
  662. name pattern of the same type that you can specify in
  663. the \fB.cvswrappers\fR file.
  664. Available with the following commands: \fBimport\fR,
  665. and \fBupdate\fR.
  666. .SP
  667. .SP
  668. .SH "add"
  669. .SS "Add files and directories to the repository"
  670. .IX "add (subcommand)"
  671. .SP
  672. .IP "\(bu" 2
  673. Synopsis: add [-k rcs-kflag] [-m message] files...
  674. .IP "\(bu" 2
  675. Requires: repository, working directory.
  676. .IP "\(bu" 2
  677. Changes: repository, working directory.
  678. .SP
  679. The \fBadd\fR command is used to present new files
  680. and directories for addition into the \fBcvs\fR
  681. repository. When \fBadd\fR is used on a directory,
  682. a new directory is created in the repository
  683. immediately. When used on a file, only the working
  684. directory is updated. Changes to the repository are
  685. not made until the \fBcommit\fR command is used on
  686. the newly added file.
  687. .SP
  688. The \fBadd\fR command also resurrects files that
  689. have been previously removed. This can be done
  690. before or after the \fBcommit\fR command is used
  691. to finalize the removal of files. Resurrected files
  692. are restored into the working directory at the time
  693. the \fBadd\fR command is executed.
  694. .SP
  695. .SH "add options"
  696. .SP
  697. These standard options are supported by \fBadd\fR
  698. (see node `Common options\(aq in the CVS manual, for a complete description of
  699. them):
  700. .SP
  701. .IP "" 0
  702. \fB-k \fIkflag\fB\fR
  703. .IP "" 2
  704. Process keywords according to \fIkflag\fR. See
  705. `Keyword substitution\(aq in the CVS manual.
  706. This option is sticky; future updates of
  707. this file in this working directory will use the same
  708. \fIkflag\fR. The \fBstatus\fR command can be viewed
  709. to see the sticky options. For more information on
  710. the \fBstatus\fR command, see node `Invoking CVS\(aq in the CVS manual.
  711. .SP
  712. .IP "" 0
  713. \fB-m \fImessage\fB\fR
  714. .IP "" 2
  715. Use \fImessage\fR as the log message, instead of
  716. invoking an editor.
  717. .SP
  718. .SH "add examples"
  719. .SP
  720. .SS "Adding a directory"
  721. .SP
  722. .PD 0
  723. .SP
  724. .IP "" 2
  725. $ mkdir doc
  726. .IP "" 2
  727. $ cvs add doc
  728. .IP "" 2
  729. Directory /path/to/repository/doc added to the repository
  730. .PD
  731. .IP "" 0
  732. .SP
  733. .SS "Adding a file"
  734. .SP
  735. .PD 0
  736. .SP
  737. .SP
  738. .IP "" 2
  739. $ >TODO
  740. .IP "" 2
  741. $ cvs add TODO
  742. .IP "" 2
  743. cvs add: scheduling file \`TODO\(aq for addition
  744. .IP "" 2
  745. cvs add: use \(aqcvs commit\(aq to add this file permanently
  746. .PD
  747. .IP "" 0
  748. .SP
  749. .SS "Undoing a \fBremove\fR command"
  750. .SP
  751. .PD 0
  752. .SP
  753. .IP "" 2
  754. $ rm -f makefile
  755. .IP "" 2
  756. $ cvs remove makefile
  757. .IP "" 2
  758. cvs remove: scheduling \`makefile\(aq for removal
  759. .IP "" 2
  760. cvs remove: use \(aqcvs commit\(aq to remove this file permanently
  761. .IP "" 2
  762. $ cvs add makefile
  763. .IP "" 2
  764. U makefile
  765. .IP "" 2
  766. cvs add: makefile, version 1.2, resurrected
  767. .PD
  768. .IP "" 0
  769. .SP
  770. .SH "admin"
  771. .SS "Administration"
  772. .IX "Admin (subcommand)"
  773. .SP
  774. .IP "\(bu" 2
  775. Requires: repository, working directory.
  776. .IP "\(bu" 2
  777. Changes: repository.
  778. .IP "\(bu" 2
  779. Synonym: rcs
  780. .SP
  781. This is the \fBcvs\fR interface to assorted
  782. administrative facilities. Some of them have
  783. questionable usefulness for \fBcvs\fR but exist for
  784. historical purposes. Some of the questionable options
  785. are likely to disappear in the future. This command
  786. \fIdoes\fR work recursively, so extreme care should be
  787. used.
  788. .SP
  789. .IX "cvsadmin"
  790. On unix, if there is a group named \fBcvsadmin\fR,
  791. only members of that group can run \fBcvs admin\fR
  792. (except for the \fBcvs admin -k\fR command, which can
  793. be run by anybody). This group should exist on the
  794. server, or any system running the non-client/server
  795. \fBcvs\fR. To disallow \fBcvs admin\fR for all users,
  796. create a group with no users in it. On NT, the
  797. \fBcvsadmin\fR feature does not exist and all users
  798. can run \fBcvs admin\fR.
  799. .SP
  800. .SH "admin options"
  801. .SP
  802. Some of these options have questionable usefulness for
  803. \fBcvs\fR but exist for historical purposes. Some even
  804. make it impossible to use \fBcvs\fR until you undo the
  805. effect!
  806. .SP
  807. .IP "" 0
  808. \fB-A\fIoldfile\fB\fR
  809. .IP "" 2
  810. Might not work together with \fBcvs\fR. Append the
  811. access list of \fIoldfile\fR to the access list of the
  812. \fBrcs\fR file.
  813. .SP
  814. .IP "" 0
  815. \fB-a\fIlogins\fB\fR
  816. .IP "" 2
  817. Might not work together with \fBcvs\fR. Append the
  818. login names appearing in the comma-separated list
  819. \fIlogins\fR to the access list of the \fBrcs\fR file.
  820. .SP
  821. .IP "" 0
  822. \fB-b[\fIrev\fB]\fR
  823. .IP "" 2
  824. Set the default branch to \fIrev\fR. In \fBcvs\fR, you
  825. normally do not manipulate default branches; sticky
  826. tags (see node `Sticky tags\(aq in the CVS manual) are a better way to decide
  827. which branch you want to work on. There is one reason
  828. to run \fBcvs admin -b\fR: to revert to the vendor\(aqs
  829. version when using vendor branches (see node `Reverting
  830. local changes\(aq in the CVS manual).
  831. There can be no space between \fB-b\fR and its argument.
  832. .SP
  833. .IX "Comment leader"
  834. .IP "" 0
  835. \fB-c\fIstring\fB\fR
  836. .IP "" 2
  837. Sets the comment leader to \fIstring\fR. The comment
  838. leader is not used by current versions of \fBcvs\fR or
  839. \fBrcs\fR 5.7. Therefore, you can almost surely not
  840. worry about it. See `Keyword substitution\(aq in the CVS manual.
  841. .SP
  842. .IP "" 0
  843. \fB-e[\fIlogins\fB]\fR
  844. .IP "" 2
  845. Might not work together with \fBcvs\fR. Erase the login
  846. names appearing in the comma-separated list
  847. \fIlogins\fR from the access list of the RCS file. If
  848. \fIlogins\fR is omitted, erase the entire access list.
  849. There can be no space between \fB-e\fR and its argument.
  850. .SP
  851. .IP "" 0
  852. \fB-I\fR
  853. .IP "" 2
  854. Run interactively, even if the standard input is not a
  855. terminal. This option does not work with the
  856. client/server \fBcvs\fR and is likely to disappear in
  857. a future release of \fBcvs\fR.
  858. .SP
  859. .IP "" 0
  860. \fB-i\fR
  861. .IP "" 2
  862. Useless with \fBcvs\fR. This creates and initializes a
  863. new \fBrcs\fR file, without depositing a revision. With
  864. \fBcvs\fR, add files with the \fBcvs add\fR command
  865. (see node `Adding files\(aq in the CVS manual).
  866. .SP
  867. .IP "" 0
  868. \fB-k\fIsubst\fB\fR
  869. .IP "" 2
  870. Set the default keyword
  871. substitution to \fIsubst\fR. See `Keyword
  872. substitution\(aq in the CVS manual. Giving an explicit \fB-k\fR option to
  873. \fBcvs update\fR, \fBcvs export\fR, or \fBcvs
  874. checkout\fR overrides this default.
  875. .SP
  876. .IP "" 0
  877. \fB-l[\fIrev\fB]\fR
  878. .IP "" 2
  879. Lock the revision with number \fIrev\fR. If a branch
  880. is given, lock the latest revision on that branch. If
  881. \fIrev\fR is omitted, lock the latest revision on the
  882. default branch. There can be no space between
  883. \fB-l\fR and its argument.
  884. .SP
  885. This can be used in conjunction with the
  886. \fBrcslock.pl\fR script in the \fBcontrib\fR
  887. directory of the \fBcvs\fR source distribution to
  888. provide reserved checkouts (where only one user can be
  889. editing a given file at a time). See the comments in
  890. that file for details (and see the \fBREADME\fR file
  891. in that directory for disclaimers about the unsupported
  892. nature of contrib). According to comments in that
  893. file, locking must set to strict (which is the default).
  894. .SP
  895. .IP "" 0
  896. \fB-L\fR
  897. .IP "" 2
  898. Set locking to strict. Strict locking means that the
  899. owner of an RCS file is not exempt from locking for
  900. checkin. For use with \fBcvs\fR, strict locking must be
  901. set; see the discussion under the \fB-l\fR option above.
  902. .SP
  903. .IX "Changing a log message"
  904. .IX "Replacing a log message"
  905. .IX "Correcting a log message"
  906. .IX "Fixing a log message"
  907. .IX "Log message, correcting"
  908. .IP "" 0
  909. \fB-m\fIrev\fB:\fImsg\fB\fR
  910. .IP "" 2
  911. Replace the log message of revision \fIrev\fR with
  912. \fImsg\fR.
  913. .SP
  914. .IP "" 0
  915. \fB-N\fIname\fB[:[\fIrev\fB]]\fR
  916. .IP "" 2
  917. Act like \fB-n\fR, except override any previous
  918. assignment of \fIname\fR. For use with magic branches,
  919. see `Magic branch numbers\(aq in the CVS manual.
  920. .SP
  921. .IP "" 0
  922. \fB-n\fIname\fB[:[\fIrev\fB]]\fR
  923. .IP "" 2
  924. Associate the symbolic name \fIname\fR with the branch
  925. or revision \fIrev\fR. It is normally better to use
  926. \fBcvs tag\fR or \fBcvs rtag\fR instead. Delete the
  927. symbolic name if both \fB:\fR and \fIrev\fR are
  928. omitted; otherwise, print an error message if
  929. \fIname\fR is already associated with another number.
  930. If \fIrev\fR is symbolic, it is expanded before
  931. association. A \fIrev\fR consisting of a branch number
  932. followed by a \fB.\fR stands for the current latest
  933. revision in the branch. A \fB:\fR with an empty
  934. \fIrev\fR stands for the current latest revision on the
  935. default branch, normally the trunk. For example,
  936. \fBcvs admin -n\fIname\fB:\fR associates \fIname\fR with the
  937. current latest revision of all the RCS files;
  938. this contrasts with \fBcvs admin -n\fIname\fB:$\fR which
  939. associates \fIname\fR with the revision numbers
  940. extracted from keyword strings in the corresponding
  941. working files.
  942. .SP
  943. .IX "Deleting revisions"
  944. .IX "Outdating revisions"
  945. .IX "Saving space"
  946. .IP "" 0
  947. \fB-o\fIrange\fB\fR
  948. .IP "" 2
  949. Deletes (\fIoutdates\fR) the revisions given by
  950. \fIrange\fR.
  951. .SP
  952. Note that this command can be quite dangerous unless
  953. you know \fIexactly\fR what you are doing (for example
  954. see the warnings below about how the
  955. \fIrev1\fR:\fIrev2\fR syntax is confusing).
  956. .SP
  957. If you are short on disc this option might help you.
  958. But think twice before using it\(emthere is no way short
  959. of restoring the latest backup to undo this command!
  960. If you delete different revisions than you planned,
  961. either due to carelessness or (heaven forbid) a \fBcvs\fR
  962. bug, there is no opportunity to correct the error
  963. before the revisions are deleted. It probably would be
  964. a good idea to experiment on a copy of the repository
  965. first.
  966. .SP
  967. Specify \fIrange\fR in one of the following ways:
  968. .SP
  969. .IP "" 2
  970. \fB\fIrev1\fB::\fIrev2\fB\fR
  971. .IP "" 4
  972. Collapse all revisions between rev1 and rev2, so that
  973. \fBcvs\fR only stores the differences associated with going
  974. from rev1 to rev2, not intermediate steps. For
  975. example, after \fB-o 1.3::1.5\fR one can retrieve
  976. revision 1.3, revision 1.5, or the differences to get
  977. from 1.3 to 1.5, but not the revision 1.4, or the
  978. differences between 1.3 and 1.4. Other examples:
  979. \fB-o 1.3::1.4\fR and \fB-o 1.3::1.3\fR have no
  980. effect, because there are no intermediate revisions to
  981. remove.
  982. .SP
  983. .IP "" 2
  984. \fB::\fIrev\fB\fR
  985. .IP "" 4
  986. Collapse revisions between the beginning of the branch
  987. containing \fIrev\fR and \fIrev\fR itself. The
  988. branchpoint and \fIrev\fR are left intact. For
  989. example, \fB-o ::1.3.2.6\fR deletes revision 1.3.2.1,
  990. revision 1.3.2.5, and everything in between, but leaves
  991. 1.3 and 1.3.2.6 intact.
  992. .SP
  993. .IP "" 2
  994. \fB\fIrev\fB::\fR
  995. .IP "" 4
  996. Collapse revisions between \fIrev\fR and the end of the
  997. branch containing \fIrev\fR. Revision \fIrev\fR is
  998. left intact but the head revision is deleted.
  999. .SP
  1000. .IP "" 2
  1001. \fB\fIrev\fB\fR
  1002. .IP "" 4
  1003. Delete the revision \fIrev\fR. For example, \fB-o
  1004. 1.3\fR is equivalent to \fB-o 1.2::1.4\fR.
  1005. .SP
  1006. .IP "" 2
  1007. \fB\fIrev1\fB:\fIrev2\fB\fR
  1008. .IP "" 4
  1009. Delete the revisions from \fIrev1\fR to \fIrev2\fR,
  1010. inclusive, on the same branch. One will not be able to
  1011. retrieve \fIrev1\fR or \fIrev2\fR or any of the
  1012. revisions in between. For example, the command
  1013. \fBcvs admin -oR_1_01:R_1_02 \&.\fR is rarely useful.
  1014. It means to delete revisions up to, and including, the
  1015. tag R_1_02. But beware! If there are files that have not
  1016. changed between R_1_02 and R_1_03 the file will have
  1017. \fIthe same\fR numerical revision number assigned to
  1018. the tags R_1_02 and R_1_03. So not only will it be
  1019. impossible to retrieve R_1_02; R_1_03 will also have to
  1020. be restored from the tapes! In most cases you want to
  1021. specify \fIrev1\fR::\fIrev2\fR instead.
  1022. .SP
  1023. .IP "" 2
  1024. \fB:\fIrev\fB\fR
  1025. .IP "" 4
  1026. Delete revisions from the beginning of the
  1027. branch containing \fIrev\fR up to and including
  1028. \fIrev\fR.
  1029. .SP
  1030. .IP "" 2
  1031. \fB\fIrev\fB:\fR
  1032. .IP "" 4
  1033. Delete revisions from revision \fIrev\fR, including
  1034. \fIrev\fR itself, to the end of the branch containing
  1035. \fIrev\fR.
  1036. .SP
  1037. None of the revisions to be deleted may have
  1038. branches or locks.
  1039. .SP
  1040. If any of the revisions to be deleted have symbolic
  1041. names, and one specifies one of the \fB::\fR syntaxes,
  1042. then \fBcvs\fR will give an error and not delete any
  1043. revisions. If you really want to delete both the
  1044. symbolic names and the revisions, first delete the
  1045. symbolic names with \fBcvs tag -d\fR, then run
  1046. \fBcvs admin -o\fR. If one specifies the
  1047. non-\fB::\fR syntaxes, then \fBcvs\fR will delete the
  1048. revisions but leave the symbolic names pointing to
  1049. nonexistent revisions. This behavior is preserved for
  1050. compatibility with previous versions of \fBcvs\fR, but
  1051. because it isn\(aqt very useful, in the future it may
  1052. change to be like the \fB::\fR case.
  1053. .SP
  1054. Due to the way \fBcvs\fR handles branches \fIrev\fR
  1055. cannot be specified symbolically if it is a branch.
  1056. See `Magic branch numbers\(aq in the CVS manual for an explanation.
  1057. .SP
  1058. Make sure that no-one has checked out a copy of the
  1059. revision you outdate. Strange things will happen if he
  1060. starts to edit it and tries to check it back in. For
  1061. this reason, this option is not a good way to take back
  1062. a bogus commit; commit a new revision undoing the bogus
  1063. change instead (see node `Merging two revisions\(aq in the CVS manual).
  1064. .SP
  1065. .IP "" 0
  1066. \fB-q\fR
  1067. .IP "" 2
  1068. Run quietly; do not print diagnostics.
  1069. .SP
  1070. .IP "" 0
  1071. \fB-s\fIstate\fB[:\fIrev\fB]\fR
  1072. .IP "" 2
  1073. Useful with \fBcvs\fR. Set the state attribute of the
  1074. revision \fIrev\fR to \fIstate\fR. If \fIrev\fR is a
  1075. branch number, assume the latest revision on that
  1076. branch. If \fIrev\fR is omitted, assume the latest
  1077. revision on the default branch. Any identifier is
  1078. acceptable for \fIstate\fR. A useful set of states is
  1079. \fBExp\fR (for experimental), \fBStab\fR (for
  1080. stable), and \fBRel\fR (for released). By default,
  1081. the state of a new revision is set to \fBExp\fR when
  1082. it is created. The state is visible in the output from
  1083. \fIcvs log\fR (see node `log\(aq in the CVS manual), and in the
  1084. \fB$\fP\fPLog$\fR and \fB$\fP\fPState$\fR keywords
  1085. (see node `Keyword substitution\(aq in the CVS manual). Note that \fBcvs\fR
  1086. uses the \fBdead\fR state for its own purposes (see node `Attic\(aq in the CVS manual); to
  1087. take a file to or from the \fBdead\fR state use
  1088. commands like \fBcvs remove\fR and \fBcvs add\fR
  1089. (see node `Adding and removing\(aq in the CVS manual), not \fBcvs admin -s\fR.
  1090. .SP
  1091. .IP "" 0
  1092. \fB-t[\fIfile\fB]\fR
  1093. .IP "" 2
  1094. Useful with \fBcvs\fR. Write descriptive text from the
  1095. contents of the named \fIfile\fR into the RCS file,
  1096. deleting the existing text. The \fIfile\fR pathname
  1097. may not begin with \fB-\fR. The descriptive text can be seen in the
  1098. output from \fBcvs log\fR (see node `log\(aq in the CVS manual).
  1099. There can be no space between \fB-t\fR and its argument.
  1100. .SP
  1101. If \fIfile\fR is omitted,
  1102. obtain the text from standard input, terminated by
  1103. end-of-file or by a line containing \fB.\fR by itself.
  1104. Prompt for the text if interaction is possible; see
  1105. \fB-I\fR.
  1106. .SP
  1107. .IP "" 0
  1108. \fB-t-\fIstring\fB\fR
  1109. .IP "" 2
  1110. Similar to \fB-t\fIfile\fB\fR. Write descriptive text
  1111. from the \fIstring\fR into the \fBrcs\fR file, deleting
  1112. the existing text.
  1113. There can be no space between \fB-t\fR and its argument.
  1114. .SP
  1115. .IP "" 0
  1116. \fB-U\fR
  1117. .IP "" 2
  1118. Set locking to non-strict. Non-strict locking means
  1119. that the owner of a file need not lock a revision for
  1120. checkin. For use with \fBcvs\fR, strict locking must be
  1121. set; see the discussion under the \fB-l\fR option
  1122. above.
  1123. .SP
  1124. .IP "" 0
  1125. \fB-u[\fIrev\fB]\fR
  1126. .IP "" 2
  1127. See the option \fB-l\fR above, for a discussion of
  1128. using this option with \fBcvs\fR. Unlock the revision
  1129. with number \fIrev\fR. If a branch is given, unlock
  1130. the latest revision on that branch. If \fIrev\fR is
  1131. omitted, remove the latest lock held by the caller.
  1132. Normally, only the locker of a revision may unlock it;
  1133. somebody else unlocking a revision breaks the lock.
  1134. This causes the original locker to be sent a \fBcommit\fR
  1135. notification (see node `Getting Notified\(aq in the CVS manual).
  1136. There can be no space between \fB-u\fR and its argument.
  1137. .SP
  1138. .IP "" 0
  1139. \fB-V\fIn\fB\fR
  1140. .IP "" 2
  1141. In previous versions of \fBcvs\fR, this option meant to
  1142. write an \fBrcs\fR file which would be acceptable to
  1143. \fBrcs\fR version \fIn\fR, but it is now obsolete and
  1144. specifying it will produce an error.
  1145. .SP
  1146. .IP "" 0
  1147. \fB-x\fIsuffixes\fB\fR
  1148. .IP "" 2
  1149. In previous versions of \fBcvs\fR, this was documented
  1150. as a way of specifying the names of the \fBrcs\fR
  1151. files. However, \fBcvs\fR has always required that the
  1152. \fBrcs\fR files used by \fBcvs\fR end in \fB,v\fR, so
  1153. this option has never done anything useful.
  1154. .SP
  1155. .SP
  1156. .SH "annotate"
  1157. .SS "What revision modified each line of a file?"
  1158. .IX "annotate (subcommand)"
  1159. .SP
  1160. .IP "\(bu" 2
  1161. Synopsis: annotate [options] files\&...
  1162. .IP "\(bu" 2
  1163. Requires: repository.
  1164. .IP "\(bu" 2
  1165. Synonym: blame
  1166. .IP "\(bu" 2
  1167. Changes: nothing.
  1168. .SP
  1169. For each file in \fIfiles\fR, print the head revision
  1170. of the trunk, together with information on the last
  1171. modification for each line.
  1172. .SP
  1173. .SH "annotate options"
  1174. .SP
  1175. These standard options are supported by \fBannotate\fR
  1176. (see node `Common options\(aq in the CVS manual for a complete description of
  1177. them):
  1178. .SP
  1179. .IP "" 0
  1180. \fB-l\fR
  1181. .IP "" 2
  1182. Local directory only, no recursion.
  1183. .SP
  1184. .IP "" 0
  1185. \fB-R\fR
  1186. .IP "" 2
  1187. Process directories recursively.
  1188. .SP
  1189. .IP "" 0
  1190. \fB-f\fR
  1191. .IP "" 2
  1192. Use head revision if tag/date not found.
  1193. .SP
  1194. .IP "" 0
  1195. \fB-F\fR
  1196. .IP "" 2
  1197. Annotate binary files.
  1198. .SP
  1199. .IP "" 0
  1200. \fB-r \fIrevision\fB\fR
  1201. .IP "" 2
  1202. Annotate file as of specified revision/tag.
  1203. .SP
  1204. .IP "" 0
  1205. \fB-D \fIdate\fB\fR
  1206. .IP "" 2
  1207. Annotate file as of specified date.
  1208. .SP
  1209. .SH "annotate example"
  1210. .SP
  1211. For example:
  1212. .SP
  1213. .PD 0
  1214. .SP
  1215. .IP "" 2
  1216. $ cvs annotate ssfile
  1217. .IP "" 2
  1218. Annotations for ssfile
  1219. .IP "" 2
  1220. ***************
  1221. .IP "" 2
  1222. 1.1 (mary 27-Mar-96): ssfile line 1
  1223. .IP "" 2
  1224. 1.2 (joe 28-Mar-96): ssfile line 2
  1225. .PD
  1226. .IP "" 0
  1227. .SP
  1228. The file \fBssfile\fR currently contains two lines.
  1229. The \fBssfile line 1\fR line was checked in by
  1230. \fBmary\fR on March 27. Then, on March 28, \fBjoe\fR
  1231. added a line \fBssfile line 2\fR, without modifying
  1232. the \fBssfile line 1\fR line. This report doesn\(aqt
  1233. tell you anything about lines which have been deleted
  1234. or replaced; you need to use \fBcvs diff\fR for that
  1235. (see node `diff\(aq in the CVS manual).
  1236. .SP
  1237. The options to \fBcvs annotate\fR are listed in
  1238. `Invoking CVS\(aq in the CVS manual, and can be used to select the files
  1239. and revisions to annotate. The options are described
  1240. in more detail there and in `Common options\(aq in the CVS manual.
  1241. .SP
  1242. .SH "checkout"
  1243. .SS "Check out sources for editing"
  1244. .IX "checkout (subcommand)"
  1245. .IX "co (subcommand)"
  1246. .SP
  1247. .IP "\(bu" 2
  1248. Synopsis: checkout [options] modules\&...
  1249. .IP "\(bu" 2
  1250. Requires: repository.
  1251. .IP "\(bu" 2
  1252. Changes: working directory.
  1253. .IP "\(bu" 2
  1254. Synonyms: co, get
  1255. .SP
  1256. Create or update a working directory containing copies of the
  1257. source files specified by \fImodules\fR. You must execute
  1258. \fBcheckout\fR before using most of the other \fBcvs\fR
  1259. commands, since most of them operate on your working
  1260. directory.
  1261. .SP
  1262. The \fImodules\fR are either
  1263. symbolic names for some
  1264. collection of source directories and files, or paths to
  1265. directories or files in the repository. The symbolic
  1266. names are defined in the \fBmodules\fR file.
  1267. See `modules\(aq in the CVS manual.
  1268. .SP
  1269. Depending on the modules you specify, \fBcheckout\fR may
  1270. recursively create directories and populate them with
  1271. the appropriate source files. You can then edit these
  1272. source files at any time (regardless of whether other
  1273. software developers are editing their own copies of the
  1274. sources); update them to include new changes applied by
  1275. others to the source repository; or commit your work as
  1276. a permanent change to the source repository.
  1277. .SP
  1278. Note that \fBcheckout\fR is used to create
  1279. directories. The top-level directory created is always
  1280. added to the directory where \fBcheckout\fR is
  1281. invoked, and usually has the same name as the specified
  1282. module. In the case of a module alias, the created
  1283. sub-directory may have a different name, but you can be
  1284. sure that it will be a sub-directory, and that
  1285. \fBcheckout\fR will show the relative path leading to
  1286. each file as it is extracted into your private work
  1287. area (unless you specify the \fB-Q\fR global option).
  1288. .SP
  1289. The files created by \fBcheckout\fR are created
  1290. read-write, unless the \fB-r\fR option to \fBcvs\fR
  1291. (see node `Global options\(aq in the CVS manual) is specified, the
  1292. \fBCVSREAD\fR environment variable is specified
  1293. (see node `Environment variables\(aq in the CVS manual), or a watch is in
  1294. effect for that file (see node `Watches\(aq in the CVS manual).
  1295. .SP
  1296. Note that running \fBcheckout\fR on a directory that was already
  1297. built by a prior \fBcheckout\fR is also permitted.
  1298. This is similar to specifying the \fB-d\fR option
  1299. to the \fBupdate\fR command in the sense that new
  1300. directories that have been created in the repository
  1301. will appear in your work area.
  1302. However, \fBcheckout\fR takes a module name whereas
  1303. \fBupdate\fR takes a directory name. Also
  1304. to use \fBcheckout\fR this way it must be run from the
  1305. top level directory (where you originally ran
  1306. \fBcheckout\fR from), so before you run
  1307. \fBcheckout\fR to update an existing directory, don\(aqt
  1308. forget to change your directory to the top level
  1309. directory.
  1310. .SP
  1311. For the output produced by the \fBcheckout\fR command,
  1312. see node `update output\(aq in the CVS manual.
  1313. .SP
  1314. .SH "checkout options"
  1315. .SP
  1316. These standard options are supported by \fBcheckout\fR
  1317. (see node `Common options\(aq in the CVS manual for a complete description of
  1318. them):
  1319. .SP
  1320. .IP "" 0
  1321. \fB-D \fIdate\fB\fR
  1322. .IP "" 2
  1323. Use the most recent revision no later than \fIdate\fR.
  1324. This option is sticky, and implies \fB-P\fR. See
  1325. `Sticky tags\(aq in the CVS manual for more information on sticky tags/dates.
  1326. .SP
  1327. .IP "" 0
  1328. \fB-f\fR
  1329. .IP "" 2
  1330. Only useful with the \fB-D \fIdate\fB\fR or \fB-r
  1331. \fItag\fB\fR flags. If no matching revision is found,
  1332. retrieve the most recent revision (instead of ignoring
  1333. the file).
  1334. .SP
  1335. .IP "" 0
  1336. \fB-k \fIkflag\fB\fR
  1337. .IP "" 2
  1338. Process keywords according to \fIkflag\fR. See
  1339. `Keyword substitution\(aq in the CVS manual.
  1340. This option is sticky; future updates of
  1341. this file in this working directory will use the same
  1342. \fIkflag\fR. The \fBstatus\fR command can be viewed
  1343. to see the sticky options. See `Invoking CVS\(aq in the CVS manual for
  1344. more information on the \fBstatus\fR command.
  1345. .SP
  1346. .IP "" 0
  1347. \fB-l\fR
  1348. .IP "" 2
  1349. Local; run only in current working directory.
  1350. .SP
  1351. .IP "" 0
  1352. \fB-n\fR
  1353. .IP "" 2
  1354. Do not run any checkout program (as specified
  1355. with the \fB-o\fR option in the modules file;
  1356. see node `modules\(aq in the CVS manual).
  1357. .SP
  1358. .IP "" 0
  1359. \fB-P\fR
  1360. .IP "" 2
  1361. Prune empty directories. See `Moving directories\(aq in the CVS manual.
  1362. .SP
  1363. .IP "" 0
  1364. \fB-p\fR
  1365. .IP "" 2
  1366. Pipe files to the standard output.
  1367. .SP
  1368. .IP "" 0
  1369. \fB-R\fR
  1370. .IP "" 2
  1371. Checkout directories recursively. This option is on by default.
  1372. .SP
  1373. .IP "" 0
  1374. \fB-r \fItag\fB\fR
  1375. .IP "" 2
  1376. Use revision \fItag\fR. This option is sticky, and implies \fB-P\fR.
  1377. See `Sticky tags\(aq in the CVS manual, for more information on sticky tags/dates.
  1378. .SP
  1379. In addition to those, you can use these special command
  1380. options with \fBcheckout\fR:
  1381. .SP
  1382. .IP "" 0
  1383. \fB-A\fR
  1384. .IP "" 2
  1385. Reset any sticky tags, dates, or \fB-k\fR options.
  1386. Does not reset sticky \fB-k\fR options on modified files.
  1387. See `Sticky tags\(aq in the CVS manual for more information on sticky tags/dates.
  1388. .SP
  1389. .IP "" 0
  1390. \fB-c\fR
  1391. .IP "" 2
  1392. Copy the module file, sorted, to the standard output,
  1393. instead of creating or modifying any files or
  1394. directories in your working directory.
  1395. .SP
  1396. .IP "" 0
  1397. \fB-d \fIdir\fB\fR
  1398. .IP "" 2
  1399. Create a directory called \fIdir\fR for the working
  1400. files, instead of using the module name. In general,
  1401. using this flag is equivalent to using \fBmkdir
  1402. \fIdir\fB; cd \fIdir\fB\fR followed by the checkout
  1403. command without the \fB-d\fR flag.
  1404. .SP
  1405. There is an important exception, however. It is very
  1406. convenient when checking out a single item to have the
  1407. output appear in a directory that doesn\(aqt contain empty
  1408. intermediate directories. In this case \fIonly\fR,
  1409. \fBcvs\fR tries to \`\`shorten\(aq\(aq pathnames to avoid those empty
  1410. directories.
  1411. .SP
  1412. For example, given a module \fBfoo\fR that contains
  1413. the file \fBbar.c\fR, the command \fBcvs co -d dir
  1414. foo\fR will create directory \fBdir\fR and place
  1415. \fBbar.c\fR inside. Similarly, given a module
  1416. \fBbar\fR which has subdirectory \fBbaz\fR wherein
  1417. there is a file \fBquux.c\fR, the command \fBcvs co
  1418. -d dir bar/baz\fR will create directory \fBdir\fR and
  1419. place \fBquux.c\fR inside.
  1420. .SP
  1421. Using the \fB-N\fR flag will defeat this behavior.
  1422. Given the same module definitions above, \fBcvs co
  1423. -N -d dir foo\fR will create directories \fBdir/foo\fR
  1424. and place \fBbar.c\fR inside, while \fBcvs co -N -d
  1425. dir bar/baz\fR will create directories \fBdir/bar/baz\fR
  1426. and place \fBquux.c\fR inside.
  1427. .SP
  1428. .IP "" 0
  1429. \fB-j \fItag\fB\fR
  1430. .IP "" 2
  1431. With two \fB-j\fR options, merge changes from the
  1432. revision specified with the first \fB-j\fR option to
  1433. the revision specified with the second \fBj\fR option,
  1434. into the working directory.
  1435. .SP
  1436. With one \fB-j\fR option, merge changes from the
  1437. ancestor revision to the revision specified with the
  1438. \fB-j\fR option, into the working directory. The
  1439. ancestor revision is the common ancestor of the
  1440. revision which the working directory is based on, and
  1441. the revision specified in the \fB-j\fR option.
  1442. .SP
  1443. In addition, each -j option can contain an optional
  1444. date specification which, when used with branches, can
  1445. limit the chosen revision to one within a specific
  1446. date. An optional date is specified by adding a colon
  1447. (:) to the tag:
  1448. \fB-j\fISymbolic_Tag\fB:\fIDate_Specifier\fB\fR.
  1449. .SP
  1450. See `Branching and merging\(aq in the CVS manual.
  1451. .SP
  1452. .IP "" 0
  1453. \fB-N\fR
  1454. .IP "" 2
  1455. Only useful together with \fB-d \fIdir\fB\fR. With
  1456. this option, \fBcvs\fR will not \`\`shorten\(aq\(aq module paths
  1457. in your working directory when you check out a single
  1458. module. See the \fB-d\fR flag for examples and a
  1459. discussion.
  1460. .SP
  1461. .IP "" 0
  1462. \fB-s\fR
  1463. .IP "" 2
  1464. Like \fB-c\fR, but include the status of all modules,
  1465. and sort it by the status string. See `modules\(aq in the CVS manual, for
  1466. info about the \fB-s\fR option that is used inside the
  1467. modules file to set the module status.
  1468. .SP
  1469. .SH "checkout examples"
  1470. .SP
  1471. Get a copy of the module \fBtc\fR:
  1472. .SP
  1473. .PD 0
  1474. .SP
  1475. .IP "" 2
  1476. $ cvs checkout tc
  1477. .PD
  1478. .IP "" 0
  1479. .SP
  1480. Get a copy of the module \fBtc\fR as it looked one day
  1481. ago:
  1482. .SP
  1483. .PD 0
  1484. .SP
  1485. .IP "" 2
  1486. $ cvs checkout -D yesterday tc
  1487. .PD
  1488. .IP "" 0
  1489. .SP
  1490. .SH "commit"
  1491. .SS "Check files into the repository"
  1492. .IX "commit (subcommand)"
  1493. .SP
  1494. .IP "\(bu" 2
  1495. Synopsis: commit [-lRf] [-m \(aqlog_message\(aq |
  1496. -F file] [-r revision] [files\&...]
  1497. .IP "\(bu" 2
  1498. Requires: working directory, repository.
  1499. .IP "\(bu" 2
  1500. Changes: repository.
  1501. .IP "\(bu" 2
  1502. Synonym: ci
  1503. .SP
  1504. Use \fBcommit\fR when you want to incorporate changes
  1505. from your working source files into the source
  1506. repository.
  1507. .SP
  1508. If you don\(aqt specify particular files to commit, all of
  1509. the files in your working current directory are
  1510. examined. \fBcommit\fR is careful to change in the
  1511. repository only those files that you have really
  1512. changed. By default (or if you explicitly specify the
  1513. \fB-R\fR option), files in subdirectories are also
  1514. examined and committed if they have changed; you can
  1515. use the \fB-l\fR option to limit \fBcommit\fR to the
  1516. current directory only.
  1517. .SP
  1518. \fBcommit\fR verifies that the selected files are up
  1519. to date with the current revisions in the source
  1520. repository; it will notify you, and exit without
  1521. committing, if any of the specified files must be made
  1522. current first with \fBupdate\fR (see node `update\(aq in the CVS manual).
  1523. \fBcommit\fR does not call the \fBupdate\fR command
  1524. for you, but rather leaves that for you to do when the
  1525. time is right.
  1526. .SP
  1527. When all is well, an editor is invoked to allow you to
  1528. enter a log message that will be written to one or more
  1529. logging programs (see node `modules\(aq in the CVS manual, and see node `loginfo\(aq in the CVS manual)
  1530. and placed in the \fBrcs\fR file inside the
  1531. repository. This log message can be retrieved with the
  1532. \fBlog\fR command; see node `log\(aq in the CVS manual. You can specify the
  1533. log message on the command line with the \fB-m
  1534. \fImessage\fB\fR option, and thus avoid the editor invocation,
  1535. or use the \fB-F \fIfile\fB\fR option to specify
  1536. that the argument file contains the log message.
  1537. .SP
  1538. .SH "commit options"
  1539. .SP
  1540. These standard options are supported by \fBcommit\fR
  1541. (see node `Common options\(aq in the CVS manual for a complete description of
  1542. them):
  1543. .SP
  1544. .IP "" 0
  1545. \fB-l\fR
  1546. .IP "" 2
  1547. Local; run only in current working directory.
  1548. .SP
  1549. .IP "" 0
  1550. \fB-R\fR
  1551. .IP "" 2
  1552. Commit directories recursively. This is on by default.
  1553. .SP
  1554. .IP "" 0
  1555. \fB-r \fIrevision\fB\fR
  1556. .IP "" 2
  1557. Commit to \fIrevision\fR. \fIrevision\fR must be
  1558. either a branch, or a revision on the main trunk that
  1559. is higher than any existing revision number
  1560. (see node `Assigning revisions\(aq in the CVS manual). You
  1561. cannot commit to a specific revision on a branch.
  1562. .SP
  1563. \fBcommit\fR also supports these options:
  1564. .SP
  1565. .IP "" 0
  1566. \fB-F \fIfile\fB\fR
  1567. .IP "" 2
  1568. Read the log message from \fIfile\fR, instead
  1569. of invoking an editor.
  1570. .SP
  1571. .IP "" 0
  1572. \fB-f\fR
  1573. .IP "" 2
  1574. Note that this is not the standard behavior of
  1575. the \fB-f\fR option as defined in `Common options\(aq in the CVS manual.
  1576. .SP
  1577. Force \fBcvs\fR to commit a new revision even if you haven\(aqt
  1578. made any changes to the file. If the current revision
  1579. of \fIfile\fR is 1.7, then the following two commands
  1580. are equivalent:
  1581. .SP
  1582. .PD 0
  1583. .SP
  1584. .IP "" 4
  1585. $ cvs commit -f \fIfile\fR
  1586. .IP "" 4
  1587. $ cvs commit -r 1.8 \fIfile\fR
  1588. .PD