[Cvs-cvs] Changes to ccvs/doc/cvs.texinfo

[Derek Robert Price]

Index: ccvs/doc/cvs.texinfo
diff -u ccvs/doc/cvs.texinfo:1.659 ccvs/doc/cvs.texinfo:1.660
--- ccvs/doc/cvs.texinfo:1.659  Tue Sep  6 04:11:24 2005
+++ ccvs/doc/cvs.texinfo        Tue Sep  6 05:12:05 2005
@@ -14554,28 +14554,47 @@
 Currently defined keywords are:
 
 @table @code
address@hidden RCSBIN, in CVSROOT/config
address@hidden address@hidden
-For @sc{cvs} 1.9.12 through 1.9.18, this setting told
address@hidden to look for @sc{rcs} programs in the
address@hidden directory.  Current versions of @sc{cvs}
-do not run @sc{rcs} programs; for compatibility this
-setting is accepted, but it does nothing.
address@hidden HistoryLogPath, in CVSROOT/config
address@hidden address@hidden
+Request that @sc{cvs} look for its history information in files matching
address@hidden, which is a standard UNIX file glob.  If @var{pattern} matches
+multiple files, all will be searched in lexicographically sorted order.
+See @xref{history} and @xref{history file}, for more.
 
address@hidden SystemAuth, in CVSROOT/config
address@hidden address@hidden
-If @var{value} is @samp{yes}, then pserver should check
-for users in the system's user database if not found in
address@hidden/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
address@hidden authenticated}.
+If no value is supplied for this option, it defaults to
address@hidden/CVSROOT/history}.
 
address@hidden LocalKeyword, in CVSROOT/config
address@hidden address@hidden
-Specify a local alias for a standard keyword.
-For example, @samp{LocalKeyword=MYCVS=CVSHeader}.
-For more on local keywords, see @ref{Keyword substitution}.
address@hidden HistorySearchPath, in CVSROOT/config
address@hidden address@hidden
+Control where @sc{cvs} logs its history.  If the file does not exist, @sc{cvs}
+will attempt to create it.  Format strings, as available to the GNU C
address@hidden function and often the UNIX date command, and the string
address@hidden will be substituted in this path.  For example, consider the
+line:
+
address@hidden
+HistoryLogPath=$CVSROOT/CVSROOT/history/%Y-%m-%d
address@hidden example
+
+This line would cause @sc{cvs} to attempt to create its history file in a
+subdirectory (@file{history}) of the configuration directory (@file{CVSROOT})
+with a name equal to the current date representation in the ISO8601 format (for
+example, on May 11, 2005, @sc{cvs} would attempt to log its history under the
+repository root directory in a file named @file{CVSROOT/history/2005-05-11}).
+See @xref{history} and @xref{history file}, for more.
+
+If no value is supplied for this option, it defaults to
address@hidden/CVSROOT/history}.
+
address@hidden ImportNewFilesToVendorBranchOnly, in CVSROOT/config
address@hidden import, config admin file
address@hidden config (admin file), import
address@hidden address@hidden
+Specify whether @code{cvs import} should always behave as if the
address@hidden flag was specified on the command line.  
address@hidden may be either @samp{yes} or @samp{no}.  If set to @samp{yes},
+all uses of @code{cvs import} on the repository will behave as if the
address@hidden flag was set.  The default value is @samp{no}.
 
 @cindex KeywordExpand, in CVSROOT/config
 @item address@hidden
@@ -14585,32 +14604,11 @@
 (for example, @samp{KeywordExpand=eCVSHeader}).
 For more on keyword expansion, see @ref{Configuring keyword expansion}.
 
address@hidden
address@hidden PreservePermissions, in CVSROOT/config
address@hidden address@hidden
-Enable support for saving special device files,
-symbolic links, file permissions and ownerships in the
-repository.  The default value is @samp{no}.
address@hidden Files}, for the full implications of using
-this keyword.
address@hidden ignore
-
address@hidden TopLevelAdmin, in CVSROOT/config
address@hidden address@hidden
-Modify the @samp{checkout} command to create a
address@hidden 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
address@hidden/Template} file (@pxref{Working directory
-storage}).
address@hidden LocalKeyword, in CVSROOT/config
address@hidden address@hidden
+Specify a local alias for a standard keyword.
+For example, @samp{LocalKeyword=MYCVS=CVSHeader}.
+For more on local keywords, see @ref{Keyword substitution}.
 
 @cindex LockDir, in CVSROOT/config
 @item address@hidden
@@ -14648,37 +14646,79 @@
 @file{*,v} files, use @samp{LogHistory=TMAR}.)  To disable history logging
 completely, use @samp{LogHistory=}.
 
address@hidden HistorySearchPath, in CVSROOT/config
address@hidden address@hidden
-Control where @sc{cvs} logs its history.  If the file does not exist, @sc{cvs}
-will attempt to create it.  Format strings, as available to the GNU C
address@hidden function and often the UNIX date command, and the string
address@hidden will be substituted in this path.  For example, consider the
-line:
address@hidden MaxCommentLeaderLength, in CVSROOT/config
address@hidden Log keyword, configuring substitution behavior
address@hidden address@hidden
+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
address@hidden@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
address@hidden below).  Defaults to 20 bytes to allow checkouts
+to proceed normally when they include binary files containing
address@hidden@splitrcskeyword{Log}$} keywords and which users have neglected 
to mark
+as binary.
 
address@hidden
-HistoryLogPath=$CVSROOT/CVSROOT/history/%Y-%m-%d
address@hidden example
address@hidden MinCompressionLevel, in CVSROOT/config
address@hidden MaxCompressionLevel, in CVSROOT/config
address@hidden Compression levels, restricting on server
address@hidden address@hidden
address@hidden address@hidden
+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.
 
-This line would cause @sc{cvs} to attempt to create its history file in a
-subdirectory (@file{history}) of the configuration directory (@file{CVSROOT})
-with a name equal to the current date representation in the ISO8601 format (for
-example, on May 11, 2005, @sc{cvs} would attempt to log its history under the
-repository root directory in a file named @file{CVSROOT/history/2005-05-11}).
-See @xref{history} and @xref{history file}, for more.
+The exception is when level 0 (no compression) is not available and the client
+fails to request any compression.  The @sc{cvs} server will then exit with an
+error message when it becomes apparent that the client is not going to request
+compression.  This will not happen with clients version 1.12.13 and later since
+these client versions allow the server to notify them that they must request
+some level of compression.
 
-If no value is supplied for this option, it defaults to
address@hidden/CVSROOT/history}.
address@hidden
address@hidden PreservePermissions, in CVSROOT/config
address@hidden address@hidden
+Enable support for saving special device files,
+symbolic links, file permissions and ownerships in the
+repository.  The default value is @samp{no}.
address@hidden Files}, for the full implications of using
+this keyword.
address@hidden ignore
 
address@hidden HistoryLogPath, in CVSROOT/config
address@hidden address@hidden
-Request that @sc{cvs} look for its history information in files matching
address@hidden, which is a standard UNIX file glob.  If @var{pattern} matches
-multiple files, all will be searched in lexicographically sorted order.
-See @xref{history} and @xref{history file}, for more.
address@hidden PrimaryServer, in CVSROOT/config
address@hidden Primary server
address@hidden Secondary server
address@hidden proxy, write
address@hidden write proxy
address@hidden address@hidden
+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
address@hidden 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.
 
-If no value is supplied for this option, it defaults to
address@hidden/CVSROOT/history}.
+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.
+
address@hidden RCSBIN, in CVSROOT/config
address@hidden address@hidden
+For @sc{cvs} 1.9.12 through 1.9.18, this setting told
address@hidden to look for @sc{rcs} programs in the
address@hidden directory.  Current versions of @sc{cvs}
+do not run @sc{rcs} programs; for compatibility this
+setting is accepted, but it does nothing.
 
 @cindex RereadLogAfterVerify, in CVSROOT/config
 @cindex @file{verifymsg}, changing the log message
@@ -14700,42 +14740,57 @@
 @xref{verifymsg}, for more information on how verifymsg
 may be used.
 
address@hidden UserAdminOptions, in CVSROOT/config
address@hidden address@hidden
-Control what options will be allowed with the @code{cvs admin}
-command (@pxref{admin}) for users not in the @code{cvsadmin} group.
-The @var{value} string is a list of single character options
-which should be allowed.  If a user who is not a member of the
address@hidden group tries to execute any @code{cvs admin}
-option which is not listed they will will receive an error message
-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
address@hidden  In other words, it defaults to allowing
-users outside of the @code{cvsadmin} group to use the
address@hidden 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}.
address@hidden SystemAuth, in CVSROOT/config
address@hidden address@hidden
+If @var{value} is @samp{yes}, then pserver should check
+for users in the system's user database if not found in
address@hidden/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
address@hidden authenticated}.
 
address@hidden TmpDir, in config
 @cindex temporary files, location of
 @cindex temporary directory, set in config
address@hidden TmpDir, in config
 @item address@hidden
 Specify @var{path} as the directory to create temporary files in.
 @xref{Global options} for more on setting the path to the temporary
 directory.  This option first appeared with @sc{cvs} release 1.12.13.
 
address@hidden TopLevelAdmin, in CVSROOT/config
address@hidden address@hidden
+Modify the @samp{checkout} command to create a
address@hidden 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
address@hidden/Template} file (@pxref{Working directory
+storage}).
+
address@hidden UseArchiveCommentLeader, in CVSROOT/config
address@hidden Log keyword, configuring substitution behavior
address@hidden address@hidden
+Set to @code{true}, if the text preceding a @address@hidden
+keyword is found to exceed @code{MaxCommentLeaderLength} (above) 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
address@hidden 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 @address@hidden expansion skipped in
+files where the comment leader has not been set in the archive file), set
address@hidden and set @code{MaxCommentLeaderLength} to @code{0}.
+
address@hidden UseNewInfoFmtStrings, in CVSROOT/config
 @cindex format strings, config admin file
 @cindex config (admin file), updating legacy repositories
 @cindex compatibility notes, config admin file
address@hidden UseNewInfoFmtStrings, in CVSROOT/config
 @item address@hidden
 Specify whether @sc{cvs} should support the new or old command line
 template model for the commit support files (@pxref{commit files}).
@@ -14748,84 +14803,29 @@
 @emph{Note that new repositories (created with the @code{cvs init} command)
 will have this value set to @samp{yes}, but the default value is @samp{no}.}
 
address@hidden import, config admin file
address@hidden config (admin file), import
address@hidden ImportNewFilesToVendorBranchOnly, in CVSROOT/config
address@hidden address@hidden
-Specify whether @code{cvs import} should always behave as if the
address@hidden flag was specified on the command line.  
address@hidden may be either @samp{yes} or @samp{no}.  If set to @samp{yes},
-all uses of @code{cvs import} on the repository will behave as if the
address@hidden flag was set.  The default value is @samp{no}.
-
address@hidden PrimaryServer, in CVSROOT/config
address@hidden Primary server
address@hidden Secondary server
address@hidden proxy, write
address@hidden write proxy
address@hidden address@hidden
-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
address@hidden 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.
-
address@hidden MaxCommentLeaderLength, in CVSROOT/config
address@hidden Log keyword, configuring substitution behavior
address@hidden address@hidden
-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
address@hidden@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
address@hidden below).  Defaults to 20 bytes to allow checkouts
-to proceed normally when they include binary files containing
address@hidden@splitrcskeyword{Log}$} keywords and which users have neglected 
to mark
-as binary.
address@hidden UserAdminOptions, in CVSROOT/config
address@hidden address@hidden
+Control what options will be allowed with the @code{cvs admin}
+command (@pxref{admin}) for users not in the @code{cvsadmin} group.
+The @var{value} string is a list of single character options
+which should be allowed.  If a user who is not a member of the
address@hidden group tries to execute any @code{cvs admin}
+option which is not listed they will will receive an error message
+reporting that the option is restricted.
 
address@hidden UseArchiveCommentLeader, in CVSROOT/config
address@hidden Log keyword, configuring substitution behavior
address@hidden address@hidden
-Set to @code{true}, if the text preceding a @address@hidden
-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
address@hidden 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 @address@hidden expansion skipped in
-files where the comment leader has not been set in the archive file), set
address@hidden and set @code{MaxCommentLeaderLength} to @code{0}.
+If no @code{cvsadmin} group exists on the server, @sc{cvs} will
+ignore the @code{UserAdminOptions} keyword (@pxref{admin}).
 
address@hidden MinCompressionLevel, in CVSROOT/config
address@hidden MaxCompressionLevel, in CVSROOT/config
address@hidden Compression levels, restricting on server
address@hidden address@hidden
address@hidden address@hidden
-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.
+When not specified, @code{UserAdminOptions} defaults to
address@hidden  In other words, it defaults to allowing
+users outside of the @code{cvsadmin} group to use the
address@hidden admin} command only to change the default keyword
+expansion mode for files.
 
-The exception is when level 0 (no compression) is not available and the client
-fails to request any compression.  The @sc{cvs} server will then exit with an
-error message when it becomes apparent that the client is not going to request
-compression.  This will not happen with clients version 1.12.13 and later since
-these client versions allow the server to notify them that they must request
-some level of compression.
+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}.
 @end table