$OpenBSD: patch-ctm_ctm_ctm_5,v 1.2 2007/10/31 23:14:46 ajacoutot Exp $
--- ctm/ctm/ctm.5.orig	Wed Oct 31 23:06:34 2007
+++ ctm/ctm/ctm.5	Wed Oct 31 23:06:34 2007
@@ -1,5 +1,5 @@
 .\"----------------------------------------------------------------------------
-.\""THE BEER-WARE LICENSE" (Revision 42): 
+.\""THE BEER-WARE LICENSE" (Revision 42):
 .\"<joerg@freebsd.org> wrote this file.  As long as you retain this notice you
 .\"can do whatever you want with this stuff. If we meet some day, and you think
 .\"this stuff is worth it, you can buy me a beer in return.       Joerg Wunsch
@@ -18,66 +18,63 @@
 .Sh NAME
 .Nm ctm
 .Nd source code mirror system
-
 .Sh DESCRIPTION
 The
-.Nm ctm
+.Nm
 transfers data in a specific file format, called a CTM delta.
-
+.Pp
 CTM deltas consist of control lines and data chunks.  Each control
 line starts with the letters
 .Dq CTM ,
-followed by a CTM statement and control data, and ends with a '\en'
+followed by a CTM statement and control data, and ends with a
+newline
+.Pq Sq \en
 character.
-
-Data chunks always belong to the preceeding control line, and the
+.Pp
+Data chunks always belong to the preceding control line, and the
 last field on that control line is the number of bytes in the data
 chunk.
-A trailing newline '\en' character follows each data chunk, this
+A trailing newline
+character follows each data chunk. This
 newline is not part of the chunk and isn't included in the count.
-
-The CTM statements are as follows.
+.Pp
+The CTM statements are as follows:
 .Bl -tag -width indent
-
 .It _BEGIN Ar version name number timestamp prefix
-
 This is the overall begin of a CTM delta file.  The
 .Ar version
 field must match the program version
 .Pq currently 2.0 .
-.Ar Name
+.Ar name
 is the name and
 .Ar number
-the sequence number of the CTM service, it is matched against the file
+the sequence number of the CTM service; it is matched against the file
 .Pa .ctm_status
 to see if the delta has already been applied.
-.Ar Timestamp
+.Ar timestamp
 contains the year, month, day, hour, minute, and second of the
 time of delta creation for reference
 .Po
 followed by the letter
-.Sq Z
+.Dq Z ,
 meaning this is a UTC timestamp
 .Pc .
 The
 .Ar prefix
-This field is currently not implemented.
-
+field is currently not implemented.
 .It _END Ar md5
-
-This statement ends the CTM delta, the global
+This statement ends the CTM delta. The global
 .Ar md5
-checksum is matched against the MD5 checksum of the entire delta, up to 
-and including the space (0x20) character following ``_END''.
-
+checksum is matched against the MD5 checksum of the entire delta, up to
+and including the space (0x20) character following
+.Dq _END .
 .It \&FM Ar name uid gid mode md5 count
-
 Make the file
-.Ar name ,
-the original file had the uid
+.Ar name .
+The original file had the UID
 .Ar uid
 .Pq numerical, decimal ,
-the gid
+the GID
 .Ar gid
 .Pq numerical, decimal ,
 mode
@@ -85,19 +82,16 @@ mode
 .Pq numerical, octal ,
 and the MD5 checksum
 .Ar md5 .
-
 The following
 .Ar count
 bytes data are the contents of the new file.
-
 .It \&FS Ar name uid gid mode md5before md5after count
-
 Substitute the contents of file
-.Ar name ,
-the original file had the new uid
+.Ar name .
+The original file had the new UID
 .Ar uid
 .Pq numerical, decimal ,
-the new gid
+the new GID
 .Ar gid
 .Pq numerical, decimal ,
 new mode
@@ -107,31 +101,23 @@ the old MD5 checksum
 .Ar md5before ,
 and the new MD5 checksum
 .Ar md5after .
-
 The following
 .Ar count
 bytes data are the contents of the new file.
-
 File substitution is used if the commands to edit a file would exceed
 the total file length, so substituting it is more efficient.
-
 .It \&FN Ar name uid gid mode md5before md5after count
-
 Edit the file
 .Ar name .
-The arguments are as above, but the data sections contains an
+The arguments are as above, but the data sections contain a
 .Xr diff 1
 -n script which should be applied to the file in question.
-
 .It \&FR Ar name md5
-
 Remove the file
 .Ar name ,
 which must match the MD5 checksum
 .Ar md5 .
-
 .It \&AS Ar name uid gid mode
-
 The original file
 .Ar name
 changed its owner to
@@ -140,34 +126,25 @@ its group to
 .Ar gid ,
 and/or its mode to
 .Ar mode .
-
 .It \&DM Ar name uid gid mode
-
 The directory
 .Ar name
-is to be created, it had originally the owner
+is to be created. It had originally the owner
 .Ar uid ,
 group
 .Ar gid ,
 and mode
 .Ar mode .
-
 .It \&DR name
-
 The directory
 .Ar name
 is to be removed.
-
 .El
-
 .Sh EXAMPLES
-
 In the following example, long lines have been folded to make them
 printable
 .Pq marked by backslashes .
-
 .Bd -literal
-
 CTM_BEGIN 2.0 cvs-cur 485 19950324214652Z .
 CTMFR src/sys/gnu/i386/isa/scd.c,v 5225f13aa3c7e458f9dd0d4bb637b18d
 CTMFR src/sys/gnu/i386/isa/scdreg.h,v e5af42b8a06f2c8030b93a7d71afb223
@@ -175,35 +152,29 @@ CTMDM src/sys/gnu/i386/isa/Attic 0 552 775
 CTMFS .ctm_status 545 552 664 d9ccd2a84a9dbb8db56ba85663adebf0 \\
 e2a10c6f66428981782a0a18a789ee2e 12
 cvs-cur 485
-
+.Pp
 CTMFN CVSROOT/commitlogs/gnu 545 552 664 \\
 5d7bc3549140d860bd9641b5782c002d 7fb04ed84b48160c9b8eea84b4c0b6e3 394
 a6936 21
 ache        95/03/24 09:59:50
-
+.Pp
   Modified:    gnu/lib/libdialog kernel.c prgbox.c
   Log:
 [...]
 CTM_END 74ddd298d76215ae45a077a4b6a74e9c
-
 .Ed
-
 .Sh SEE ALSO
-
-.Xr ctm 1 ;
-.Xr ed 1 .
-
+.Xr ctm 1 ,
+.Xr ctm_rmail 1 ,
+.Xr ed 1
 .Sh HISTORY
-
-Initial trials ran during the FreeBSD 1.1.5, and many bugs and 
+Initial trials ran during the work on FreeBSD 1.1.5, and many bugs and
 methods were hashed out.
 The CTM system has been made publically available in FreeBSD 2.1.
-
 .Sh AUTHORS
-
 The CTM system has been designed and implemented by
 Poul-Henning Kamp
 .Aq phk@FreeBSD.org .
-
-Joerg Wunsch wrote this man-page.
-.Aq joerg@FreeBSD.org .
+Joerg Wunsch
+.Aq joerg@FreeBSD.org
+wrote this man page.
