add DIAGNOSTICS section about utility return codes;

input/ok jmc, ok jfb joris.

1 files changed, 29 insertions, 1 deletions

diff --git a/usr.bin/cvs/cvs.1 b/usr.bin/cvs/cvs.1
index fd1d988e524..74904585c89 100644
--- a/usr.bin/cvs/cvs.1
+++ b/usr.bin/cvs/cvs.1
@@ -1,4 +1,4 @@
-.\"	$OpenBSD: cvs.1,v 1.80 2005/08/08 15:01:05 xsa Exp $
+.\"	$OpenBSD: cvs.1,v 1.81 2005/08/09 07:24:09 xsa Exp $
 .\"
 .\" Copyright (c) 2004 Jean-Francois Brousseau <jfb@openbsd.org>
 .\" Copyright (c) 2004, 2005 Xavier Santolaria <xsa@openbsd.org>
@@ -1875,6 +1875,34 @@ Directory containing repository administrative files.
 File containing associations between modules and handlers for
 post-commit logging.
 .El
+.Sh DIAGNOSTICS
+The
+.Nm
+utility exits 0 on success, or with one of the following return codes.
+The numerical values corresponding to the symbolic ones are given in
+parentheses for easy reference.
+.Pp
+.Bl -tag -width Ds
+.It Dv CVS_EX_USAGE Pq 1
+The
+.Nm
+command was used incorrectly.
+Either with the wrong number of arguments, a bad flag, a bad syntax in
+a parameter, etc...
+.It Dv CVS_EX_DATA Pq 2
+The input data was incorrect in some way.
+.It Dv CVS_EX_PROTO Pq 3
+The remote system returned something that was not possible during
+a protocol exchange.
+.It Dv CVS_EX_FILE Pq 4
+An error occurred while doing an operation on a file.
+.It Dv CVS_EX_BADTAG Pq 5
+An error occured while doing a tagging/untagging operation.
+.It Dv CVS_EX_BADROOT Pq 6
+The
+.Ev CVSROOT
+was not given or does not match the expected format.
+.El
 .Sh SEE ALSO
 .Xr diff 1 ,
 .Xr gzip 1 ,