Trivial documentation patch

[Jon Jensen]

On Sat, 25 Oct 2003, jw schultz wrote:

> I just wonder, having had my attention brought to this part of the
> manpage, what value it is to have the RERR_* names in the manpage.  
> They are internal names with no bearing outside the source code.  It
> seems to me that it would be more readable if we just gave the numbers
> and meaning like so:
>        
> |      1      Syntax or usage error
> |
> |      2      Protocol incompatibility
> |
> |      3      Errors selecting input/output files, dirs
> |
> |      4      Requested action not supported: an attempt was made
> |             to manipulate 64-bit files on a platform that  can­
> |             not  support  them; or an option was speciifed that

Yeah, I think it's a good idea to simplify if the symbolic names don't 
mean anything outside rsync itself. Here's a patch that does that and adds 
"0" too, just for completeness. This time I also built the manpage too 
so I hope the patch is usable as is.

Jon


--- rsync.1	7 Oct 2003 20:33:08 -0000	1.143
+++ rsync.1	25 Oct 2003 17:32:50 -0000
@@ -1266,36 +1266,40 @@
 .PP 
 .SH "EXIT VALUES" 
 .PP 
-.IP "\fBRERR_SYNTAX 1\fP" 
-Syntax or usage error 
-.IP "\fBRERR_PROTOCOL 2\fP" 
-Protocol incompatibility 
-.IP "\fBRERR_FILESELECT 3\fP" 
+.IP "\fB0\fP" 
+Success
+.IP "\fB1\fP" 
+Syntax or usage error
+.IP "\fB2\fP" 
+Protocol incompatibility
+.IP "\fB3\fP" 
 Errors selecting input/output files, dirs
-.IP 
-.IP "\fBRERR_UNSUPPORTED 4\fP" 
-Requested action not supported: an attempt
-was made to manipulate 64-bit files on a platform that cannot support
-them; or an option was speciifed that is supported by the client and
-not by the server\&.
-.IP 
-.IP "\fBRERR_SOCKETIO 10\fP" 
+.IP "\fB4\fP" 
+Requested action not supported: an attempt was made to
+manipulate 64-bit files on a platform that cannot support them; or
+an option was speciifed that is supported by the client and not by
+the server\&.
+.IP "\fB5\fP" 
+Error starting client-server protocol
+.IP "\fB10\fP" 
 Error in socket IO 
-.IP "\fBRERR_FILEIO 11\fP" 
+.IP "\fB11\fP" 
 Error in file IO 
-.IP "\fBRERR_STREAMIO 12\fP" 
+.IP "\fB12\fP" 
 Error in rsync protocol data stream 
-.IP "\fBRERR_MESSAGEIO 13\fP" 
+.IP "\fB13\fP" 
 Errors with program diagnostics 
-.IP "\fBRERR_IPC 14\fP" 
+.IP "\fB14\fP" 
 Error in IPC code 
-.IP "\fBRERR_SIGNAL 20\fP" 
+.IP "\fB20\fP" 
 Received SIGUSR1 or SIGINT 
-.IP "\fBRERR_WAITCHILD 21\fP" 
+.IP "\fB21\fP" 
 Some error returned by waitpid() 
-.IP "\fBRERR_MALLOC 22\fP" 
+.IP "\fB22\fP" 
 Error allocating core memory buffers 
-.IP "\fBRERR_TIMEOUT 30\fP" 
+.IP "\fB23\fP" 
+Partial transfer
+.IP "\fB30\fP" 
 Timeout in data send/receive 
 .PP 
 .SH "ENVIRONMENT VARIABLES" 
--- rsync.yo	7 Oct 2003 20:33:08 -0000	1.128
+++ rsync.yo	25 Oct 2003 17:32:51 -0000
@@ -1109,24 +1109,25 @@
 manpagesection(EXIT VALUES)
 
 startdit()
-dit(bf(RERR_SYNTAX     1))       Syntax or usage error 
-dit(bf(RERR_PROTOCOL   2))       Protocol incompatibility 
-dit(bf(RERR_FILESELECT 3))       Errors selecting input/output files, dirs
-
-dit(bf(RERR_UNSUPPORTED 4)) Requested action not supported: an attempt
-was made to manipulate 64-bit files on a platform that cannot support
-them; or an option was speciifed that is supported by the client and
-not by the server.
-
-dit(bf(RERR_SOCKETIO   10))      Error in socket IO 
-dit(bf(RERR_FILEIO     11))      Error in file IO 
-dit(bf(RERR_STREAMIO   12))      Error in rsync protocol data stream 
-dit(bf(RERR_MESSAGEIO  13))      Errors with program diagnostics 
-dit(bf(RERR_IPC        14))      Error in IPC code 
-dit(bf(RERR_SIGNAL     20))      Received SIGUSR1 or SIGINT 
-dit(bf(RERR_WAITCHILD  21))      Some error returned by waitpid() 
-dit(bf(RERR_MALLOC     22))      Error allocating core memory buffers 
-dit(bf(RERR_TIMEOUT    30))      Timeout in data send/receive 
+dit(bf(0)) Success
+dit(bf(1)) Syntax or usage error
+dit(bf(2)) Protocol incompatibility
+dit(bf(3)) Errors selecting input/output files, dirs
+dit(bf(4)) Requested action not supported: an attempt was made to
+manipulate 64-bit files on a platform that cannot support them; or
+an option was speciifed that is supported by the client and not by
+the server.
+dit(bf(5)) Error starting client-server protocol
+dit(bf(10)) Error in socket IO 
+dit(bf(11)) Error in file IO 
+dit(bf(12)) Error in rsync protocol data stream 
+dit(bf(13)) Errors with program diagnostics 
+dit(bf(14)) Error in IPC code 
+dit(bf(20)) Received SIGUSR1 or SIGINT 
+dit(bf(21)) Some error returned by waitpid() 
+dit(bf(22)) Error allocating core memory buffers 
+dit(bf(23)) Partial transfer
+dit(bf(30)) Timeout in data send/receive 
 enddit()
 
 manpagesection(ENVIRONMENT VARIABLES)