diff options
author | Jason McIntyre <jmc@cvs.openbsd.org> | 2004-12-02 22:38:31 +0000 |
---|---|---|
committer | Jason McIntyre <jmc@cvs.openbsd.org> | 2004-12-02 22:38:31 +0000 |
commit | 3660bf7675f2a82502089f112860c0193304d92a (patch) | |
tree | 91a75089b6958cb55acfbed5eacc4bc0f10c7759 | |
parent | ce7f9f5f9741a1d8317fea95cb39c801b17c446d (diff) |
man tweaks;
discussed w/ jfb@
-rw-r--r-- | usr.bin/cvs/cvs.1 | 83 | ||||
-rw-r--r-- | usr.bin/cvs/cvsd.8 | 9 | ||||
-rw-r--r-- | usr.bin/cvs/cvsd.conf.5 | 49 | ||||
-rw-r--r-- | usr.bin/cvs/cvsintro.7 | 19 |
4 files changed, 82 insertions, 78 deletions
diff --git a/usr.bin/cvs/cvs.1 b/usr.bin/cvs/cvs.1 index 818111f41bd..e2f062883ed 100644 --- a/usr.bin/cvs/cvs.1 +++ b/usr.bin/cvs/cvs.1 @@ -1,4 +1,4 @@ -.\" $OpenBSD: cvs.1,v 1.7 2004/11/26 16:14:12 jfb Exp $ +.\" $OpenBSD: cvs.1,v 1.8 2004/12/02 22:38:30 jmc Exp $ .\" .\" Copyright (c) 2004 Jean-Francois Brousseau <jfb@openbsd.org> .\" All rights reserved. @@ -83,7 +83,7 @@ The value must specify an absolute path. Use the program .Ar editor whenever editing log information. -This option overrides the environment variables CVSEDITOR, VISUAL and EDITOR. +This option overrides the environment variables CVSEDITOR, VISUAL, and EDITOR. .It Fl f Do not read the user's configuration file on startup. .It Fl l @@ -132,8 +132,8 @@ target CVS repository. .Pp .It Xo Sy commit .Op Fl flnR -.Op Fl m Ar msg .Op Fl F Ar logfile +.Op Fl m Ar msg .Op Fl r Ar rev .Op Ar file ... .Xc @@ -167,7 +167,7 @@ repository into the local one where the command was run. .Pp The .Fl A -flag resets any sticky tags, dates or kopts that have been set on the tree. +flag resets any sticky tags, dates, or kopts that have been set on the tree. The .Fl l flag is used to specify a local change only and disables the recursive @@ -186,27 +186,14 @@ an other machine, .Nm will also connect to the server and ask it to print its version information. .El -.Sh FILES -.Bl -tag -width Ds -.It Pa $HOME/.cvsrc -File containing a list of implicit options to pass to certain commands. -This file is read on startup unless the -.Fl f -option is specified. -.It Pa $CVSROOT/CVSROOT -Directory containing repository administrative files. -.It Pa $CVSROOT/CVSROOT/loginfo -File containing associations between modules and handlers for -post-commit logging. -.El .Sh ENVIRONMENT .Bl -tag -width CVS_CLIENT_LOG -.It Ev CVSROOT -When set, this variable should contain the string pointing to the root -directory of the CVS repository. -The contents of this variable are ignored when the -.Fl d -option is given or if `Root' files exist in the checked-out copy. +.It Ev CVS_CLIENT_LOG +This variable enables logging of all communications between the client and +server when running in non-local mode. +If set, this environment variable must contain a base path from which two +paths will be generated by appending ".in" to the value for the server's +input and ".out" for the server's output. .It Ev CVS_RSH Name of the program to use when connecting to the server through a remote shell. @@ -220,30 +207,37 @@ server when using remote shell. The default is to use `cvs'. .It Ev CVSEDITOR Name of the editor to use when editing commit messages. -Checked before EDITOR and VISUAL. +Checked before +.Ev EDITOR +and +.Ev VISUAL . +.It Ev CVSROOT +When set, this variable should contain the string pointing to the root +directory of the CVS repository. +The contents of this variable are ignored when the +.Fl d +option is given or if `Root' files exist in the checked-out copy. .It Ev EDITOR .It Ev VISUAL -.It Ev CVS_CLIENT_LOG -This variable enables logging of all communications between the client and -server when running in non-local mode. -If set, this environment variable must contain a base path from which two -paths will be generated by appending ".in" to the value for the server's -input and ".out" for the server's output. +.El +.Sh FILES +.Bl -tag -width Ds +.It Pa $HOME/.cvsrc +File containing a list of implicit options to pass to certain commands. +This file is read on startup unless the +.Fl f +option is specified. +.It Pa $CVSROOT/CVSROOT +Directory containing repository administrative files. +.It Pa $CVSROOT/CVSROOT/loginfo +File containing associations between modules and handlers for +post-commit logging. .El .Sh SEE ALSO -.Xr rcs 1 , .Xr diff 1 , .Xr patch 1 , +.Xr rcs 1 , .Xr cvsd 8 -.Sh CAVEATS -This CVS implementation does not fully conform to the GNU CVS version. -In some cases, this was done explicitly because GNU CVS has inconsistencies -or ambiguous behaviour. -Some things have also been left out or modified to enhance the overall -security of the system. -.Pp -Among other things, support for the pserver connection mechanism has been -dropped because of security issues with the authentication mechanism. .Sh HISTORY The OpenCVS project is a BSD-licensed rewrite of the original Concurrent Versioning System written by Jean-Francois Brousseau. @@ -253,3 +247,12 @@ Brian Berliner and Jeff Polk. .An Jean-Francois Brousseau .An Vincent Labrecque .An Joris Vink +.Sh CAVEATS +This CVS implementation does not fully conform to the GNU CVS version. +In some cases, this was done explicitly because GNU CVS has inconsistencies +or ambiguous behaviour. +Some things have also been left out or modified to enhance the overall +security of the system. +.Pp +Among other things, support for the pserver connection mechanism has been +dropped because of security issues with the authentication mechanism. diff --git a/usr.bin/cvs/cvsd.8 b/usr.bin/cvs/cvsd.8 index 8280abf363a..47506e14b4a 100644 --- a/usr.bin/cvs/cvsd.8 +++ b/usr.bin/cvs/cvsd.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: cvsd.8,v 1.3 2004/09/27 12:16:06 jfb Exp $ +.\" $OpenBSD: cvsd.8,v 1.4 2004/12/02 22:38:30 jmc Exp $ .\" .\" Copyright (c) 2004 Jean-Francois Brousseau <jfb@openbsd.org> .\" @@ -47,7 +47,7 @@ model commonly used by .Xr cvs 1 through various mechanisms described below. .Pp -On startup, +On startup, .Nm spawns a child process that chroots to the CVS repository's root directory. Both processes then drop privileges to user and group @@ -59,7 +59,7 @@ the child's jail. .Pp .Nm provides a way to apply Access Control Lists on the modules based on -operation, path, tags and users. +operation, path, tags, and users. In order to enforce ACLs and prevent users from modifying the files in the repository directly, all of the files within the repository should be owned by the user and group @@ -110,6 +110,7 @@ Drop user privileges to the username or UID specified by instead of the default user. .It Fl v Be verbose. +.El .Sh FILES .Bl -tag -width /var/run/cvsd.sock -compact .It Pa /etc/cvsd.conf @@ -128,6 +129,6 @@ Default listening socket for incoming cvs requests. .Sh HISTORY The .Nm -server appeared as part of the OpenCVS project. +server first appeared as part of the OpenCVS project. .Sh AUTHORS .An Jean-Francois Brousseau diff --git a/usr.bin/cvs/cvsd.conf.5 b/usr.bin/cvs/cvsd.conf.5 index 8c0994db089..4fa5bf7ada6 100644 --- a/usr.bin/cvs/cvsd.conf.5 +++ b/usr.bin/cvs/cvsd.conf.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: cvsd.conf.5,v 1.2 2004/08/03 14:47:30 jfb Exp $ +.\" $OpenBSD: cvsd.conf.5,v 1.3 2004/12/02 22:38:30 jmc Exp $ .\" .\" Copyright (c) 2004 Jean-Francois Brousseau <jfb@openbsd.org> .\" @@ -42,15 +42,17 @@ server restart. It is a human-readable text file consisting of one-line directives that the server handles to modify its configuration and Access Control List rules to control operations on the repository. -Comments can be inserted anywhere in the file by putting a '#' character -before them and span to the end of the line. -.Pp +Comments can be inserted anywhere in the file by putting a +.Sq # +character before them and span to the end of the line. .Sh MACROS To simplify maintenance of the configuration, the format allows for the definition of variables that can later be used for interpolation throughout -the configuration file by preceding them with the '$' character. +the configuration file by preceding them with the +.Sq $ +character. These variables are refered to as macros throughout the rest of the document. -A macro name must start with a letter and can be composed of letters, digits +A macro name must start with a letter and can be composed of letters, digits, and underscores. .Pp Here is an example of macro usage: @@ -77,12 +79,12 @@ to the list of addresses on which the server will listen for incoming connections. This is currently parsed but ignored, as the CVS daemon doesn't support direct TCP connections yet. -.It Sy minchild Ar num -Set the server's minimum number of child processes to -.Ar num . .It Sy maxchild Ar num Set the server's maximum number of child processes to .Ar num . +.It Sy minchild Ar num +Set the server's minimum number of child processes to +.Ar num . .It Sy reqsock Ar path Set the server's local socket path to .Ar path . @@ -109,8 +111,20 @@ Here is the BNF syntax for .Nm rules: .Bl -tag -width "this is a test" +.It Ic action +::= allow | deny .It Ic line ::= +.It Ic op +::= add | commit | tag | update +.It Ic option +::= quick | log +.It Ic optlist +::= +.Ic option +| +.Ic optlist , +.Ic option .It Ic rule ::= .Ic action @@ -125,26 +139,13 @@ rules: [ from .Ic userlist ] -.It Ic action -::= allow | deny -.It Ic option -::= quick | log -.It Ic optlist -::= -.Ic option -| -.Ic optlist , -.Ic option -.It Ic op -::= add | commit | tag | update .It Ic userlist ::= .El -.Pp .Sh EXAMPLES The following rule denies all operations: -.Bd -literal - deny quick any +.Bd -literal -offset indent +deny quick any .Ed .Sh FILES .Bl -tag -width /etc/cvsd.conf -compact diff --git a/usr.bin/cvs/cvsintro.7 b/usr.bin/cvs/cvsintro.7 index 28586c76231..162da2d1472 100644 --- a/usr.bin/cvs/cvsintro.7 +++ b/usr.bin/cvs/cvsintro.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: cvsintro.7,v 1.1 2004/11/26 15:57:16 jfb Exp $ +.\" $OpenBSD: cvsintro.7,v 1.2 2004/12/02 22:38:30 jmc Exp $ .\" .\" Copyright (c) 2004 Jean-Francois Brousseau <jfb@openbsd.org> .\" All rights reserved. @@ -53,12 +53,18 @@ information for the files that it will host. .Sh REMOVING FILES -.Pp .Sh SEE ALSO -.Xr rcs 1 , .Xr diff 1 , .Xr patch 1 , +.Xr rcs 1 , .Xr cvsd 8 +.Sh HISTORY +The OpenCVS project is a BSD-licensed rewrite of the original +Concurrent Versioning System written by Jean-Francois Brousseau. +The original CVS code was written in large parts by Dick Grune, +Brian Berliner, and Jeff Polk. +.Sh AUTHORS +.An Jean-Francois Brousseau .Sh CAVEATS This CVS implementation does not fully conform to the GNU CVS version. In some cases, this was done explicitly because GNU CVS has inconsistencies @@ -68,10 +74,3 @@ security of the system. .Pp Among other things, support for the pserver connection mechanism has been dropped because of security issues with the authentication mechanism. -.Sh HISTORY -The OpenCVS project is a BSD-licensed rewrite of the original -Concurrent Versioning System written by Jean-Francois Brousseau. -The original CVS code was written in large parts by Dick Grune, -Brian Berliner and Jeff Polk. -.Sh AUTHORS -.An Jean-Francois Brousseau |