14554 |
Currently defined keywords are: |
Currently defined keywords are: |
14555 |
|
|
14556 |
@table @code |
@table @code |
14557 |
@cindex RCSBIN, in CVSROOT/config |
@cindex HistoryLogPath, in CVSROOT/config |
14558 |
@item RCSBIN=@var{bindir} |
@item HistorySearchPath=@var{pattern} |
14559 |
For @sc{cvs} 1.9.12 through 1.9.18, this setting told |
Request that @sc{cvs} look for its history information in files matching |
14560 |
@sc{cvs} to look for @sc{rcs} programs in the |
@var{pattern}, which is a standard UNIX file glob. If @var{pattern} matches |
14561 |
@var{bindir} directory. Current versions of @sc{cvs} |
multiple files, all will be searched in lexicographically sorted order. |
14562 |
do not run @sc{rcs} programs; for compatibility this |
See @xref{history} and @xref{history file}, for more. |
|
setting is accepted, but it does nothing. |
|
14563 |
|
|
14564 |
@cindex SystemAuth, in CVSROOT/config |
If no value is supplied for this option, it defaults to |
14565 |
@item SystemAuth=@var{value} |
@file{$CVSROOT/CVSROOT/history}. |
|
If @var{value} is @samp{yes}, then pserver should check |
|
|
for users in the system's user database if not found in |
|
|
@file{CVSROOT/passwd}. If it is @samp{no}, then all |
|
|
pserver users must exist in @file{CVSROOT/passwd}. |
|
|
The default is @samp{yes}. For more on pserver, see |
|
|
@ref{Password authenticated}. |
|
14566 |
|
|
14567 |
@cindex LocalKeyword, in CVSROOT/config |
@cindex HistorySearchPath, in CVSROOT/config |
14568 |
@item LocalKeyword=@var{value} |
@item HistoryLogPath=@var{path} |
14569 |
Specify a local alias for a standard keyword. |
Control where @sc{cvs} logs its history. If the file does not exist, @sc{cvs} |
14570 |
For example, @samp{LocalKeyword=MYCVS=CVSHeader}. |
will attempt to create it. Format strings, as available to the GNU C |
14571 |
For more on local keywords, see @ref{Keyword substitution}. |
@code{strftime} function and often the UNIX date command, and the string |
14572 |
|
@var{$CVSROOT} will be substituted in this path. For example, consider the |
14573 |
|
line: |
14574 |
|
|
14575 |
|
@example |
14576 |
|
HistoryLogPath=$CVSROOT/CVSROOT/history/%Y-%m-%d |
14577 |
|
@end example |
14578 |
|
|
14579 |
|
This line would cause @sc{cvs} to attempt to create its history file in a |
14580 |
|
subdirectory (@file{history}) of the configuration directory (@file{CVSROOT}) |
14581 |
|
with a name equal to the current date representation in the ISO8601 format (for |
14582 |
|
example, on May 11, 2005, @sc{cvs} would attempt to log its history under the |
14583 |
|
repository root directory in a file named @file{CVSROOT/history/2005-05-11}). |
14584 |
|
See @xref{history} and @xref{history file}, for more. |
14585 |
|
|
14586 |
|
If no value is supplied for this option, it defaults to |
14587 |
|
@file{$CVSROOT/CVSROOT/history}. |
14588 |
|
|
14589 |
|
@cindex ImportNewFilesToVendorBranchOnly, in CVSROOT/config |
14590 |
|
@cindex import, config admin file |
14591 |
|
@cindex config (admin file), import |
14592 |
|
@item ImportNewFilesToVendorBranchOnly=@var{value} |
14593 |
|
Specify whether @code{cvs import} should always behave as if the |
14594 |
|
@samp{-X} flag was specified on the command line. |
14595 |
|
@var{value} may be either @samp{yes} or @samp{no}. If set to @samp{yes}, |
14596 |
|
all uses of @code{cvs import} on the repository will behave as if the |
14597 |
|
@samp{-X} flag was set. The default value is @samp{no}. |
14598 |
|
|
14599 |
@cindex KeywordExpand, in CVSROOT/config |
@cindex KeywordExpand, in CVSROOT/config |
14600 |
@item KeywordExpand=@var{value} |
@item KeywordExpand=@var{value} |
14604 |
(for example, @samp{KeywordExpand=eCVSHeader}). |
(for example, @samp{KeywordExpand=eCVSHeader}). |
14605 |
For more on keyword expansion, see @ref{Configuring keyword expansion}. |
For more on keyword expansion, see @ref{Configuring keyword expansion}. |
14606 |
|
|
14607 |
@ignore |
@cindex LocalKeyword, in CVSROOT/config |
14608 |
@cindex PreservePermissions, in CVSROOT/config |
@item LocalKeyword=@var{value} |
14609 |
@item PreservePermissions=@var{value} |
Specify a local alias for a standard keyword. |
14610 |
Enable support for saving special device files, |
For example, @samp{LocalKeyword=MYCVS=CVSHeader}. |
14611 |
symbolic links, file permissions and ownerships in the |
For more on local keywords, see @ref{Keyword substitution}. |
|
repository. The default value is @samp{no}. |
|
|
@xref{Special Files}, for the full implications of using |
|
|
this keyword. |
|
|
@end ignore |
|
|
|
|
|
@cindex TopLevelAdmin, in CVSROOT/config |
|
|
@item TopLevelAdmin=@var{value} |
|
|
Modify the @samp{checkout} command to create a |
|
|
@samp{CVS} directory at the top level of the new |
|
|
working directory, in addition to @samp{CVS} |
|
|
directories created within checked-out directories. |
|
|
The default value is @samp{no}. |
|
|
|
|
|
This option is useful if you find yourself performing |
|
|
many commands at the top level of your working |
|
|
directory, rather than in one of the checked out |
|
|
subdirectories. The @file{CVS} directory created there |
|
|
will mean you don't have to specify @code{CVSROOT} for |
|
|
each command. It also provides a place for the |
|
|
@file{CVS/Template} file (@pxref{Working directory |
|
|
storage}). |
|
14612 |
|
|
14613 |
@cindex LockDir, in CVSROOT/config |
@cindex LockDir, in CVSROOT/config |
14614 |
@item LockDir=@var{directory} |
@item LockDir=@var{directory} |
14646 |
@file{*,v} files, use @samp{LogHistory=TMAR}.) To disable history logging |
@file{*,v} files, use @samp{LogHistory=TMAR}.) To disable history logging |
14647 |
completely, use @samp{LogHistory=}. |
completely, use @samp{LogHistory=}. |
14648 |
|
|
14649 |
@cindex HistorySearchPath, in CVSROOT/config |
@cindex MaxCommentLeaderLength, in CVSROOT/config |
14650 |
@item HistoryLogPath=@var{path} |
@cindex Log keyword, configuring substitution behavior |
14651 |
Control where @sc{cvs} logs its history. If the file does not exist, @sc{cvs} |
@item MaxCommentLeaderLength=@var{length} |
14652 |
will attempt to create it. Format strings, as available to the GNU C |
Set to some length, in bytes, where a trailing @samp{k}, @samp{M}, @samp{G}, |
14653 |
@code{strftime} function and often the UNIX date command, and the string |
or @samp{T} causes the preceding nubmer to be interpreted as kilobytes, |
14654 |
@var{$CVSROOT} will be substituted in this path. For example, consider the |
megabytes, gigabytes, or terrabytes, respectively, will cause |
14655 |
line: |
@code{$@splitrcskeyword{Log}$} keywords (@pxref{Keyword substitution}), with |
14656 |
|
more than @var{length} bytes preceding it on a line to be ignored (or to fall |
14657 |
|
back on the comment leader set in the RCS archive file - see |
14658 |
|
@code{UseArchiveCommentLeader} below). Defaults to 20 bytes to allow checkouts |
14659 |
|
to proceed normally when they include binary files containing |
14660 |
|
@code{$@splitrcskeyword{Log}$} keywords and which users have neglected to mark |
14661 |
|
as binary. |
14662 |
|
|
14663 |
@example |
@cindex MinCompressionLevel, in CVSROOT/config |
14664 |
HistoryLogPath=$CVSROOT/CVSROOT/history/%Y-%m-%d |
@cindex MaxCompressionLevel, in CVSROOT/config |
14665 |
@end example |
@cindex Compression levels, restricting on server |
14666 |
|
@item MinCompressionLevel=@var{value} |
14667 |
|
@itemx MaxCompressionLevel=@var{value} |
14668 |
|
Restricts the level of compression used by the @sc{cvs} server to a @var{value} |
14669 |
|
between 0 and 9. @var{value}s 1 through 9 are the same @sc{zlib} compression |
14670 |
|
levels accepted by the @samp{-z} option (@pxref{Global options}), and 0 means |
14671 |
|
no compression. When one or both of these keys are set and a client requests a |
14672 |
|
level outside the specified range, the server will simply use the closest |
14673 |
|
permissable level. Clients will continue compressing at the level requested by |
14674 |
|
the user. |
14675 |
|
|
14676 |
This line would cause @sc{cvs} to attempt to create its history file in a |
The exception is when level 0 (no compression) is not available and the client |
14677 |
subdirectory (@file{history}) of the configuration directory (@file{CVSROOT}) |
fails to request any compression. The @sc{cvs} server will then exit with an |
14678 |
with a name equal to the current date representation in the ISO8601 format (for |
error message when it becomes apparent that the client is not going to request |
14679 |
example, on May 11, 2005, @sc{cvs} would attempt to log its history under the |
compression. This will not happen with clients version 1.12.13 and later since |
14680 |
repository root directory in a file named @file{CVSROOT/history/2005-05-11}). |
these client versions allow the server to notify them that they must request |
14681 |
See @xref{history} and @xref{history file}, for more. |
some level of compression. |
14682 |
|
|
14683 |
If no value is supplied for this option, it defaults to |
@ignore |
14684 |
@file{$CVSROOT/CVSROOT/history}. |
@cindex PreservePermissions, in CVSROOT/config |
14685 |
|
@item PreservePermissions=@var{value} |
14686 |
|
Enable support for saving special device files, |
14687 |
|
symbolic links, file permissions and ownerships in the |
14688 |
|
repository. The default value is @samp{no}. |
14689 |
|
@xref{Special Files}, for the full implications of using |
14690 |
|
this keyword. |
14691 |
|
@end ignore |
14692 |
|
|
14693 |
@cindex HistoryLogPath, in CVSROOT/config |
@cindex PrimaryServer, in CVSROOT/config |
14694 |
@item HistorySearchPath=@var{pattern} |
@cindex Primary server |
14695 |
Request that @sc{cvs} look for its history information in files matching |
@cindex Secondary server |
14696 |
@var{pattern}, which is a standard UNIX file glob. If @var{pattern} matches |
@cindex proxy, write |
14697 |
multiple files, all will be searched in lexicographically sorted order. |
@cindex write proxy |
14698 |
See @xref{history} and @xref{history file}, for more. |
@item PrimaryServer=@var{CVSROOT} |
14699 |
|
When specified, and the repository specified by @var{CVSROOT} is not the one |
14700 |
|
currently being accessed, then the server will turn itself into a transparent |
14701 |
|
proxy to @var{CVSROOT} for write requests. The @var{hostname} configured as |
14702 |
|
part of @var{CVSROOT} must resolve to the same string returned by the |
14703 |
|
@command{uname} command on the primary server for this to work. Host name |
14704 |
|
resolution is performed via some combination of @command{named}, a broken out |
14705 |
|
line from @file{/etc/hosts}, and the Network Information Service (NIS or YP), |
14706 |
|
depending on the configuration of the particular system. |
14707 |
|
|
14708 |
If no value is supplied for this option, it defaults to |
Only the @samp{:ext:} method is |
14709 |
@file{$CVSROOT/CVSROOT/history}. |
currently supported for primaries (actually, @samp{:fork:} is supported as |
14710 |
|
well, but only for testing - if you find another use for accessing a primary |
14711 |
|
via the @samp{:fork:} method, please send a note to @email{bug-cvs@@nongnu.org} |
14712 |
|
about it). See @ref{Write proxies} for more on configuring and using write |
14713 |
|
proxies. |
14714 |
|
|
14715 |
|
@cindex RCSBIN, in CVSROOT/config |
14716 |
|
@item RCSBIN=@var{bindir} |
14717 |
|
For @sc{cvs} 1.9.12 through 1.9.18, this setting told |
14718 |
|
@sc{cvs} to look for @sc{rcs} programs in the |
14719 |
|
@var{bindir} directory. Current versions of @sc{cvs} |
14720 |
|
do not run @sc{rcs} programs; for compatibility this |
14721 |
|
setting is accepted, but it does nothing. |
14722 |
|
|
14723 |
@cindex RereadLogAfterVerify, in CVSROOT/config |
@cindex RereadLogAfterVerify, in CVSROOT/config |
14724 |
@cindex @file{verifymsg}, changing the log message |
@cindex @file{verifymsg}, changing the log message |
14740 |
@xref{verifymsg}, for more information on how verifymsg |
@xref{verifymsg}, for more information on how verifymsg |
14741 |
may be used. |
may be used. |
14742 |
|
|
14743 |
@cindex UserAdminOptions, in CVSROOT/config |
@cindex SystemAuth, in CVSROOT/config |
14744 |
@item UserAdminOptions=@var{value} |
@item SystemAuth=@var{value} |
14745 |
Control what options will be allowed with the @code{cvs admin} |
If @var{value} is @samp{yes}, then pserver should check |
14746 |
command (@pxref{admin}) for users not in the @code{cvsadmin} group. |
for users in the system's user database if not found in |
14747 |
The @var{value} string is a list of single character options |
@file{CVSROOT/passwd}. If it is @samp{no}, then all |
14748 |
which should be allowed. If a user who is not a member of the |
pserver users must exist in @file{CVSROOT/passwd}. |
14749 |
@code{cvsadmin} group tries to execute any @code{cvs admin} |
The default is @samp{yes}. For more on pserver, see |
14750 |
option which is not listed they will will receive an error message |
@ref{Password authenticated}. |
|
reporting that the option is restricted. |
|
|
|
|
|
If no @code{cvsadmin} group exists on the server, @sc{cvs} will |
|
|
ignore the @code{UserAdminOptions} keyword (@pxref{admin}). |
|
|
|
|
|
When not specified, @code{UserAdminOptions} defaults to |
|
|
@samp{k}. In other words, it defaults to allowing |
|
|
users outside of the @code{cvsadmin} group to use the |
|
|
@code{cvs admin} command only to change the default keyword |
|
|
expansion mode for files. |
|
|
|
|
|
As an example, to restrict users not in the @code{cvsadmin} |
|
|
group to using @code{cvs admin} to change the default keyword |
|
|
substitution mode, lock revisions, unlock revisions, and |
|
|
replace the log message, use @samp{UserAdminOptions=klum}. |
|
14751 |
|
|
14752 |
|
@cindex TmpDir, in config |
14753 |
@cindex temporary files, location of |
@cindex temporary files, location of |
14754 |
@cindex temporary directory, set in config |
@cindex temporary directory, set in config |
|
@cindex TmpDir, in config |
|
14755 |
@item TmpDir=@var{path} |
@item TmpDir=@var{path} |
14756 |
Specify @var{path} as the directory to create temporary files in. |
Specify @var{path} as the directory to create temporary files in. |
14757 |
@xref{Global options} for more on setting the path to the temporary |
@xref{Global options} for more on setting the path to the temporary |
14758 |
directory. This option first appeared with @sc{cvs} release 1.12.13. |
directory. This option first appeared with @sc{cvs} release 1.12.13. |
14759 |
|
|
14760 |
|
@cindex TopLevelAdmin, in CVSROOT/config |
14761 |
|
@item TopLevelAdmin=@var{value} |
14762 |
|
Modify the @samp{checkout} command to create a |
14763 |
|
@samp{CVS} directory at the top level of the new |
14764 |
|
working directory, in addition to @samp{CVS} |
14765 |
|
directories created within checked-out directories. |
14766 |
|
The default value is @samp{no}. |
14767 |
|
|
14768 |
|
This option is useful if you find yourself performing |
14769 |
|
many commands at the top level of your working |
14770 |
|
directory, rather than in one of the checked out |
14771 |
|
subdirectories. The @file{CVS} directory created there |
14772 |
|
will mean you don't have to specify @code{CVSROOT} for |
14773 |
|
each command. It also provides a place for the |
14774 |
|
@file{CVS/Template} file (@pxref{Working directory |
14775 |
|
storage}). |
14776 |
|
|
14777 |
|
@cindex UseArchiveCommentLeader, in CVSROOT/config |
14778 |
|
@cindex Log keyword, configuring substitution behavior |
14779 |
|
@item UseArchiveCommentLeader=@var{value} |
14780 |
|
Set to @code{true}, if the text preceding a @code{$@splitrcskeyword{Log}$} |
14781 |
|
keyword is found to exceed @code{MaxCommentLeaderLength} (above) bytes, then |
14782 |
|
the comment leader set in the RCS archive file (@pxref{admin}), if any, will |
14783 |
|
be used instead. If there is no comment leader set in the archive file or |
14784 |
|
@var{value} is set to @samp{false}, then the keyword will not be expanded |
14785 |
|
(@pxref{Keyword list}). To force the comment leader in the RCS archive file to |
14786 |
|
be used exclusively (and @code{$@splitrcskeyword{Log}$} expansion skipped in |
14787 |
|
files where the comment leader has not been set in the archive file), set |
14788 |
|
@var{value} and set @code{MaxCommentLeaderLength} to @code{0}. |
14789 |
|
|
14790 |
|
@cindex UseNewInfoFmtStrings, in CVSROOT/config |
14791 |
@cindex format strings, config admin file |
@cindex format strings, config admin file |
14792 |
@cindex config (admin file), updating legacy repositories |
@cindex config (admin file), updating legacy repositories |
14793 |
@cindex compatibility notes, config admin file |
@cindex compatibility notes, config admin file |
|
@cindex UseNewInfoFmtStrings, in CVSROOT/config |
|
14794 |
@item UseNewInfoFmtStrings=@var{value} |
@item UseNewInfoFmtStrings=@var{value} |
14795 |
Specify whether @sc{cvs} should support the new or old command line |
Specify whether @sc{cvs} should support the new or old command line |
14796 |
template model for the commit support files (@pxref{commit files}). |
template model for the commit support files (@pxref{commit files}). |
14803 |
@emph{Note that new repositories (created with the @code{cvs init} command) |
@emph{Note that new repositories (created with the @code{cvs init} command) |
14804 |
will have this value set to @samp{yes}, but the default value is @samp{no}.} |
will have this value set to @samp{yes}, but the default value is @samp{no}.} |
14805 |
|
|
14806 |
@cindex import, config admin file |
@cindex UserAdminOptions, in CVSROOT/config |
14807 |
@cindex config (admin file), import |
@item UserAdminOptions=@var{value} |
14808 |
@cindex ImportNewFilesToVendorBranchOnly, in CVSROOT/config |
Control what options will be allowed with the @code{cvs admin} |
14809 |
@item ImportNewFilesToVendorBranchOnly=@var{value} |
command (@pxref{admin}) for users not in the @code{cvsadmin} group. |
14810 |
Specify whether @code{cvs import} should always behave as if the |
The @var{value} string is a list of single character options |
14811 |
@samp{-X} flag was specified on the command line. |
which should be allowed. If a user who is not a member of the |
14812 |
@var{value} may be either @samp{yes} or @samp{no}. If set to @samp{yes}, |
@code{cvsadmin} group tries to execute any @code{cvs admin} |
14813 |
all uses of @code{cvs import} on the repository will behave as if the |
option which is not listed they will will receive an error message |
14814 |
@samp{-X} flag was set. The default value is @samp{no}. |
reporting that the option is restricted. |
|
|
|
|
@cindex PrimaryServer, in CVSROOT/config |
|
|
@cindex Primary server |
|
|
@cindex Secondary server |
|
|
@cindex proxy, write |
|
|
@cindex write proxy |
|
|
@item PrimaryServer=@var{CVSROOT} |
|
|
When specified, and the repository specified by @var{CVSROOT} is not the one |
|
|
currently being accessed, then the server will turn itself into a transparent |
|
|
proxy to @var{CVSROOT} for write requests. The @var{hostname} configured as |
|
|
part of @var{CVSROOT} must resolve to the same string returned by the |
|
|
@command{uname} command on the primary server for this to work. Host name |
|
|
resolution is performed via some combination of @command{named}, a broken out |
|
|
line from @file{/etc/hosts}, and the Network Information Service (NIS or YP), |
|
|
depending on the configuration of the particular system. |
|
|
|
|
|
Only the @samp{:ext:} method is |
|
|
currently supported for primaries (actually, @samp{:fork:} is supported as |
|
|
well, but only for testing - if you find another use for accessing a primary |
|
|
via the @samp{:fork:} method, please send a note to @email{bug-cvs@@nongnu.org} |
|
|
about it). See @ref{Write proxies} for more on configuring and using write |
|
|
proxies. |
|
|
|
|
|
@cindex MaxCommentLeaderLength, in CVSROOT/config |
|
|
@cindex Log keyword, configuring substitution behavior |
|
|
@item MaxCommentLeaderLength=@var{length} |
|
|
Set to some length, in bytes, where a trailing @samp{k}, @samp{M}, @samp{G}, |
|
|
or @samp{T} causes the preceding nubmer to be interpreted as kilobytes, |
|
|
megabytes, gigabytes, or terrabytes, respectively, will cause |
|
|
@code{$@splitrcskeyword{Log}$} keywords (@pxref{Keyword substitution}), with |
|
|
more than @var{length} bytes preceding it on a line to be ignored (or to fall |
|
|
back on the comment leader set in the RCS archive file - see |
|
|
@code{UseArchiveCommentLeader} below). Defaults to 20 bytes to allow checkouts |
|
|
to proceed normally when they include binary files containing |
|
|
@code{$@splitrcskeyword{Log}$} keywords and which users have neglected to mark |
|
|
as binary. |
|
14815 |
|
|
14816 |
@cindex UseArchiveCommentLeader, in CVSROOT/config |
If no @code{cvsadmin} group exists on the server, @sc{cvs} will |
14817 |
@cindex Log keyword, configuring substitution behavior |
ignore the @code{UserAdminOptions} keyword (@pxref{admin}). |
|
@item UseArchiveCommentLeader=@var{value} |
|
|
Set to @code{true}, if the text preceding a @code{$@splitrcskeyword{Log}$} |
|
|
keyword is found to exceed @code{MaxCommentLeaderLength} bytes, then the |
|
|
comment leader set in the RCS archive file (@pxref{admin}), if any, will be |
|
|
used instead. If there is no comment leader set in the archive file or |
|
|
@var{value} is set to @samp{false}, then the keyword will not be expanded |
|
|
(@pxref{Keyword list}). To force the comment leader in the RCS archive file to |
|
|
be used exclusively (and @code{$@splitrcskeyword{Log}$} expansion skipped in |
|
|
files where the comment leader has not been set in the archive file), set |
|
|
@var{value} and set @code{MaxCommentLeaderLength} to @code{0}. |
|
14818 |
|
|
14819 |
@cindex MinCompressionLevel, in CVSROOT/config |
When not specified, @code{UserAdminOptions} defaults to |
14820 |
@cindex MaxCompressionLevel, in CVSROOT/config |
@samp{k}. In other words, it defaults to allowing |
14821 |
@cindex Compression levels, restricting on server |
users outside of the @code{cvsadmin} group to use the |
14822 |
@item MinCompressionLevel=@var{value} |
@code{cvs admin} command only to change the default keyword |
14823 |
@itemx MaxCompressionLevel=@var{value} |
expansion mode for files. |
|
Restricts the level of compression used by the @sc{cvs} server to a @var{value} |
|
|
between 0 and 9. @var{value}s 1 through 9 are the same @sc{zlib} compression |
|
|
levels accepted by the @samp{-z} option (@pxref{Global options}), and 0 means |
|
|
no compression. When one or both of these keys are set and a client requests a |
|
|
level outside the specified range, the server will simply use the closest |
|
|
permissable level. Clients will continue compressing at the level requested by |
|
|
the user. |
|
14824 |
|
|
14825 |
The exception is when level 0 (no compression) is not available and the client |
As an example, to restrict users not in the @code{cvsadmin} |
14826 |
fails to request any compression. The @sc{cvs} server will then exit with an |
group to using @code{cvs admin} to change the default keyword |
14827 |
error message when it becomes apparent that the client is not going to request |
substitution mode, lock revisions, unlock revisions, and |
14828 |
compression. This will not happen with clients version 1.12.13 and later since |
replace the log message, use @samp{UserAdminOptions=klum}. |
|
these client versions allow the server to notify them that they must request |
|
|
some level of compression. |
|
14829 |
@end table |
@end table |
14830 |
|
|
14831 |
|
|