rsync.yo doc patch

[jw schultz]

On Fri, Jan 23, 2004 at 12:21:13PM -0500, Aaron S. Hawley wrote:
> 
> On Fri, 23 Jan 2004, jw schultz scribbled:
> 
> > On Thu, Jan 22, 2004 at 07:00:17PM -0500, Aaron S. Hawley wrote:
> > > Patch includes fixes to man page including:
> > >  - Typos/Spelling
> > >  - Clarity
> > >  - Special characters.
> > >  - Moved around text explaining example.
> >
> > Let's keep the examples in the example, description order.
> 
> this seems to have been taken up later in the thread and is not included
> in the patch below.
> 
> > There appear to be whitespace-only changes.  If changing the location of
> > line breaks in the source do that as a seperate patch so labeled.  Then
> > the actual text changes can be considered.
> 
> Here are residual fixes from my initial patch for rsync.yo against version
> 1.144 (I noticed 1.145 was just checked-in.  the patch still worked for
> me.) Whitespace-only changes were minimized (couldn't get diff's -w and -b
> options working to my liking, any suggestions?)

Much better.

> 
> again:
> 
> Make sure I didn't confuse the exclude list/file paragraph (line ~969
> after applying the patch), I haven't used the feature and the details of
> that paragraph are a tad unclear.
> 
> responses to J.W. Schultz below.
> 
> patch at very bottom of message and at:
> http://www.uvm.edu/~ashawley/rsync/rsync.yo-1.144-ashawley.diff-u
> /a
> 
> > Parens or quotes but not both, please.  I find the : or ::
> > set off by spaces to be perfectly clear, a bit easier to
> > read and have had some cases (not here) where there was some
> > doubt whether the surrounding characters intended as quotes
> > might not be part of the string.  But if people want ":" or (:)
> > or even <:> i can live with it.
> 
> I went with (:), seemed to be the choice of a few other man pages.

Most of the time you now use () it is correct because
context makes it a parenthetic.  However, having done it
that way means you are not using quotes.  So when you have
literals that are not parenthetic the parenthasees are out
of place.

Quite frankly the more i look at them the more i dislike
your changes adding descriptive terms.

> > "Filesystems" is correct usage.  It might not be in your spelling
> > dictionary but is correct and semantically distinct from "file systems".
> > Even if it weren't for the semantic difference this closed compound
> > sould be consistant with the Chicago Manual of Style (7.84)
> 
> Don't have a copy of Chicago Manual of Style handy, but the google test
> gave me "file systems".  Those fixes are removed from the initial patch.
> 
> > Again, This is correct usage.
> > 	user name: George Washington
> > 	username: gwashin
> > Rsync is not going to extract user names from the comment
> > field and try to match them.
> 
> agreed.  not in patch.
> 
> > Pulling that out of the parenthetic is good but the choice
> > of term is one of:
> > stdin
> > standard input
> > stdin (standard input)
> > The last one only the first time stdin is used.
> 
> went with last in patch.
> 
> > > -  *?[ then expression matching is applied using the shell filename
> > > +  "*?[" then expression matching is applied using the shell filename
> > Adding quotes here confuses the issue.  The one thing that
> > might be done is to make the wildcard character list in
> > boldface as a literal expression.

Good, although i doubt it will be readily discernable
on-screen.

> 
> in patch. speaking of which:
> 
> Index: rsync.yo
> ===================================================================
> RCS file: /cvsroot/rsync/rsync.yo,v
> retrieving revision 1.144
> diff -u -r1.144 rsync.yo
> --- rsync.yo	23 Jan 2004 09:34:04 -0000	1.144
> +++ rsync.yo	23 Jan 2004 16:19:31 -0000
> @@ -48,35 +48,35 @@
> 
>  itemize(
>  	it() for copying local files. This is invoked when neither
> -	     source nor destination path contains a : separator
> +	     source nor destination path contains a single colon (:) separator

I'll use this one as an example.  You specify the character
by name and then show it.  When you do both the second will
be a parenthetic expression, either set off by ()
(parenthasees), isolated by , (commas) or em dash(es) which
would really confuse things because em dashes should not be
adjoined by spaces and are not available for display in an
in the ASCII terminal or emulator.  Personally, i find the
repeated use of this form to be tiresome.

I'd rather not take this set of changes where all you are
doing is adding a text description of the : or :: every time
they are used.  If the first time : (colon) and :: (double
colon) were used we had the text description, it might be OK
because that helps the surpising number of people who don't
know what to call the symbol--i've heard it called
double-dot and my father once had to spend half an hour on
the phone describing where the character was on the keyboard
and that it differed from the semi-colon, with a secretary
who didn't know the word and had to type D: on a dos prompt.

> 
>  	it() for copying from the local machine to a remote machine using
>  	a remote shell program as the transport (such as ssh or
>  	rsh). This is invoked when the destination path contains a
> -	single : separator.
> +	single colon (:) separator.
> 
>  	it() for copying from a remote machine to the local machine
>  	using a remote shell program. This is invoked when the source
> -	contains a : separator.
> +	contains a single colon (:) separator.
> 
>  	it() for copying from a remote rsync server to the local
> -	machine. This is invoked when the source path contains a ::
> +	machine. This is invoked when the source path contains a double colon (::)
>  	separator or an rsync:// URL.
> 
>  	it() for copying from the local machine to a remote rsync
> -	server. This is invoked when the destination path contains a ::
> +	server. This is invoked when the destination path contains a double colon (::)
>  	separator or an rsync:// URL.
> 
>  	it() for copying from a remote machine using a remote shell
>  	program as the transport, using rsync server on the remote
> -	machine.  This is invoked when the source path contains a ::
> +	machine.  This is invoked when the source path contains a double colon (::)
>  	separator and the --rsh=COMMAND (aka "-e COMMAND") option is
>  	also provided.
> 
>  	it() for copying from the local machine to a remote machine
>  	using a remote shell program as the transport, using rsync
>  	server on the remote machine.  This is invoked when the
> -	destination path contains a :: separator and the
> +	destination path contains a double colon (::) separator and the
>  	--rsh=COMMAND option is also provided.
> 
>  	it() for listing files on a remote machine. This is done the
> @@ -134,7 +134,7 @@
> 
>  A trailing slash on the source changes this behavior to avoid creating an
>  additional directory level at the destination.  You can think of a trailing
> -/ on a source as meaning "copy the contents of this directory" as opposed
> +slash (/) on a source as meaning "copy the contents of this directory" as opposed
>  to "copy the directory by name", but in both cases the attributes of the
>  containing directory are transferred to the containing directory on the
>  destination.  In other words, each of the following commands copies the
> @@ -145,7 +145,7 @@
>  quote(rsync -avz /src/foo/ /dest/foo)
> 
>  You can also use rsync in local-only mode, where both the source and
> -destination don't have a ':' in the name. In this case it behaves like
> +destination don't have a colon (:) in the name. This behaves like
>  an improved copy command.
> 
>  quote(rsync somehost.mydomain.com::)
> @@ -169,8 +169,8 @@
>  that:
> 
>  itemize(
> -	it() you use a double colon :: instead of a single colon to
> -	separate the hostname from the path or an rsync:// URL.
> +	it() you use a double colon (::) instead of a single colon (:) to
> +        separate the hostname from the path or an rsync:// URL.
> 
>  	it() the remote server may print a message of the day when you
>  	connect.
> @@ -261,10 +261,10 @@
>        sync: get put)
> 
>  this allows me to sync with a CVS directory at the other end of the
> -connection. I then do cvs operations on the remote machine, which saves a
> -lot of time as the remote cvs protocol isn't very efficient.
> +connection. I then do CVS operations on the remote machine, which saves a
> +lot of time as the remote CVS protocol isn't very efficient.
> 
> -I mirror a directory between my "old" and "new" ftp sites with the
> +I mirror a directory between my "old" and "new" FTP sites with the
>  command
> 
>  quote(rsync -az -e ssh --delete ~ftp/pub/samba/ nimbus:"~ftp/pub/tridge/samba")
> @@ -677,8 +677,8 @@
>  If em(FILE) is bf(-) the list will be read from standard input.
> 
>  dit(bf(--files-from=FILE)) Using this option allows you to specify the
> -exact list of files to transfer (as read from the specified FILE or "-"
> -for stdin).  It also tweaks the default behavior of rsync to make
> +exact list of files to transfer as read from the specified FILE or if a dash (-)
> +from standard input (stdin).  It also tweaks the default behavior of rsync to make
>  transferring just the specified files and directories easier.  For
>  instance, the --relative option is enabled by default when this option
>  is used (use --no-relative if you want to turn that off), all
> @@ -688,15 +688,15 @@
>  you want it.
> 
>  The file names that are read from the FILE are all relative to the
> -source dir -- any leading slashes are removed and no ".." references are
> -allowed to go higher than the source dir.  For example, take this
> +source directory -- any leading slashes (/) are removed and no parent directory (..) references are
> +allowed to go higher than the source directory.  For example, take this
>  command:
> 
>  quote(rsync -a --files-from=/tmp/foo /usr remote:/backup)
> 
>  If /tmp/foo contains the string "bin" (or even "/bin"), the /usr/bin
>  directory will be created as /backup/bin on the remote host (but the
> -contents of the /usr/bin dir would not be sent unless you specified -r
> +contents of the /usr/bin directory would not be sent unless you specified -r
>  or the names were explicitly listed in /tmp/foo).  Also keep in mind
>  that the effect of the (enabled by default) --relative option is to
>  duplicate only the path info that is read from the file -- it does not
> @@ -705,7 +705,7 @@
>  In addition, the --files-from file can be read from the remote host
>  instead of the local host if you specify a "host:" in front of the file
>  (the host must match one end of the transfer).  As a short-cut, you can
> -specify just a prefix of ":" to mean "use the remote end of the
> +specify just a prefix of colon (:) to mean "use the remote end of the
>  transfer".  For example:
> 
>  quote(rsync -a --files-from=:/path/file-list src:/ /tmp/copy)
> @@ -918,48 +918,49 @@
> 
>  itemize(
> 
> -  it() if the pattern starts with a / then it is matched against the
> +  it() if the pattern starts with a slash (/) then it is matched against the
>    start of the filename, otherwise it is matched against the end of
>    the filename.
> -  This is the equivalent of a leading ^ in regular expressions.
> +  This is the equivalent of a leading caret (^) in regular expressions.

Are you sure you want to call a circumflex a caret?

>    Thus "/foo" would match a file called "foo" at the top of the
>    transferred tree.
>    On the other hand, "foo" would match any file called "foo"
>    anywhere in the tree because the algorithm is applied recursively from
>    top down; it behaves as if each path component gets a turn at being the
>    end of the file name.
> -  The leading / does not make the pattern an absolute pathname.
> +  The leading slash (/) does not make the pattern an absolute pathname.
> 
> -  it() if the pattern ends with a / then it will only match a
> +  it() if the pattern ends with a slash (/) then it will only match a
>    directory, not a file, link or device.
> 
>    it() if the pattern contains a wildcard character from the set
> -  *?[ then expression matching is applied using the shell filename
> +  bf(*?[) then expression matching is applied using the shell filename
>    matching rules. Otherwise a simple string match is used.
> 
> -  it() the double asterisk pattern "**" will match slashes while a
> -  single asterisk pattern "*" will stop at slashes.
> +  it() the double asterisk pattern (**) will match slashes while a
> +  single asterisk pattern (*) will stop at slashes.
> 
> -  it() if the pattern contains a / (not counting a trailing /) or a "**"
> +  it() if the pattern contains a slash (/) (not counting a trailing slash) or a double asterisk (**)
>    then it is matched against the full filename, including any leading
> -  directory. If the pattern doesn't contain a / or a "**", then it is
> +  directory. If the pattern doesn't contain a slash (/) or a double asterisk (**), then it is
>    matched only against the final component of the filename.  Again,
>    remember that the algorithm is applied recursively so "full filename" can
>    actually be any portion of a path below the starting directory.
> 
> -  it() if the pattern starts with "+ " (a plus followed by a space)
> +  it() if the pattern starts with plus-space (+ ) (a plus followed by a space)
>    then it is always considered an include pattern, even if specified as
> -  part of an exclude option. The "+ " part is discarded before matching.
> +  part of an exclude option. The plus-space (+ ) part is discarded before matching.
> 
> -  it() if the pattern starts with "- " (a minus followed by a space)
> +  it() if the pattern starts with minus-space (- ) (a minus followed by a space)
>    then it is always considered an exclude pattern, even if specified as
> -  part of an include option. The "- " part is discarded before matching.
> +  part of an include option. The minus-space (- ) part is discarded before matching.

The double parenthetic is ugly and you did it to invent two
terms not used anywhere else and minus-space sounds too much
to me like backspace.  I don't like this at all.

> 
> -  it() if the pattern is a single exclamation mark ! then the current
> +  it() if the pattern is a single exclamation mark (!) then the current
>    include/exclude list is reset, removing all previously defined patterns.
>  )
> 
> -The +/- rules are most useful in a list that was read from a file, allowing
> +The plus-space (+ ) and minus-space (- ) rules are most useful in a
> +list that was read from a file, allowing

With the context "+/- rules" is perfectly clear.

>  you to have a single exclude list that contains both include and exclude
>  options.
> 
> @@ -1094,8 +1095,9 @@
>  unsafe links to be omitted altogether.
> 
>  Symbolic links are considered unsafe if they are absolute symlinks
> -(start with bf(/)), empty, or if they contain enough bf("..")
> -components to ascend from the directory being copied.
> +(start with a slash (bf(/))), empty, or if they contain enough
> +parent directory (bf(..)) components to ascend from the directory
> +being copied.
> 
>  manpagesection(DIAGNOSTICS)
> 
> @@ -1130,10 +1132,10 @@
>  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(3)) Errors selecting input/output files, directories
>  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 specifed that is supported by the client and
> +them; or an option was specified 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 I/O
> @@ -1201,7 +1203,7 @@
> 
>  see also the comments on the --delete option
> 
> -Please report bugs! See the website at
> +Please report bugs! See the web site at

While tecnically kinda, sorta OK i'm inclined to reject the
use of "web site".  "website" is correct.  We are not
talking about the location of a web that common usage has
rendered "website".

>  url(http://rsync.samba.org/)(http://rsync.samba.org/)
> 
>  manpagesection(CREDITS)
> @@ -1214,7 +1216,7 @@
>  includes an FAQ-O-Matic which may cover questions unanswered by this
>  manual page.
> 
> -The primary ftp site for rsync is
> +The primary FTP site for rsync is
>  url(ftp://rsync.samba.org/pub/rsync)(ftp://rsync.samba.org/pub/rsync).
> 
>  We would be delighted to hear from you if you like this program.
> -- 
> To unsubscribe or change options: http://lists.samba.org/mailman/listinfo/rsync
> Before posting, read: http://www.catb.org/~esr/faqs/smart-questions.html
> 

-- 
________________________________________________________________
	J.W. Schultz            Pegasystems Technologies
	email address:		jw at pegasys.ws

		Remember Cernan and Schmitt