rsync.yo doc patch

Fri Jan 23 02:02:35 GMT 2004

On Thu, Jan 22, 2004 at 05:41:12PM -0800, Wayne Davison wrote:
> I've attempted to snag the least controversial changes out of the patch
> and checked them in.  I also changed "file system" into filesystem in
> one place, made your suggested allow->support change, and changed "id"
> to "ID" (since we're not talking about the id and the ego).  I'll
> comment more in another email.

It isn't worth its own checking but there are at least two
cases where the abreviation "etc." is misspunctuated.  It is an
abreviation of etcetera and should be marked as such.  This
does not apply to etc as a directory name.

Just a thought but with your change of id to ID (which i
agree with) it might be a good idea to change IO to I/O to
reduce the doubletake.  Or that could just be the dyslexia
talking.

More comments below.

> 
> ..wayne..

> --- rsync.yo	15 Jan 2004 17:45:53 -0000	1.139
> +++ rsync.yo	23 Jan 2004 01:32:55 -0000
> @@ -77,7 +77,7 @@
>  	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
> -	--rsh=COMMMAND option is also provided.
> +	--rsh=COMMAND option is also provided.
>  
>  	it() for listing files on a remote machine. This is done the
>  	same way as rsync transfers except that you leave off the
> @@ -111,7 +111,7 @@
>  You use rsync in the same way you use rcp. You must specify a source
>  and a destination, one of which may be remote.
>  
> -Perhaps the best way to explain the syntax is some examples:
> +Perhaps the best way to explain the syntax is with some examples:
>  
>  quote(rsync *.c foo:src/)
>  
> @@ -162,8 +162,8 @@
>  
>  You may establish the connection via a web proxy by setting the
>  environment variable RSYNC_PROXY to a hostname:port pair pointing to
> -your web proxy.  Note that your web proxy's configuration must allow
> -proxying to port 873.
> +your web proxy.  Note that your web proxy's configuration must support
> +proxy connections to port 873.
>  
>  Using rsync in this way is the same as using it with a remote shell except
>  that:
> @@ -217,7 +217,7 @@
>  
>  manpagesection(RUNNING AN RSYNC SERVER)
>  
> -An rsync server is configured using a config file.  Please see the 
> +An rsync server is configured using a configuration file.  Please see the 
>  rsyncd.conf(5) man page for more information.  By default the configuration
>  file is called /etc/rsyncd.conf, unless rsync is running over a remote
>  shell program and is not running as root; in that case, the default name
> @@ -496,7 +496,7 @@
>  is not used and the whole file is sent as-is instead.  The transfer may be
>  faster if this option is used when the bandwidth between the source and
>  target machines is higher than the bandwidth to disk (especially when the
> -"disk" is actually a networked file system).  This is the default when both
> +"disk" is actually a networked filesystem).  This is the default when both
>  the source and target are on the local machine.
>  
>  dit(bf(--no-whole-file)) Turn off --whole-file, for use when it is the
> @@ -519,7 +519,7 @@
>  dit(bf(-g, --group)) This option causes rsync to set the group of the
>  destination file to be the same as the source file.  If the receiving
>  program is not running as the super-user, only groups that the
> -receiver is a member of will be preserved (by group name, not group id
> +receiver is a member of will be preserved (by group name, not group ID
>  number).

The parenthetic should be dropped.  It will be by ID if
--numeric-ids is specified or a daemon is running chrooted.
Explaining that here would, i think, only confuse things.
Also, "receiving user" might be a better term.

>  
>  dit(bf(-D, --devices)) This option causes rsync to transfer character and
> @@ -602,7 +602,7 @@
>  default, but you may prefer to use rsh on a local network.
>  
>  If this option is used with bf([user@]host::module/path), then the
> -remote shell em(COMMMAND) will be used to run an rsync server on the
> +remote shell em(COMMAND) will be used to run an rsync server on the
>  remote host, and all data will be transmitted through that remote
>  shell connection, rather than through a direct socket connection to a
>  running rsync server on the remote host.  See the section "CONNECTING
> @@ -748,16 +748,16 @@
>  information sent for matching data blocks.
>  
>  dit(bf(--numeric-ids)) With this option rsync will transfer numeric group
> -and user ids rather than using user and group names and mapping them
> +and user IDs rather than using user and group names and mapping them
>  at both ends.
>  
> -By default rsync will use the user name and group name to determine
> +By default rsync will use the username and groupname to determine
>  what ownership to give files. The special uid 0 and the special group
>  0 are never mapped via user/group names even if the --numeric-ids
>  option is not specified.
>  
>  If the source system is a daemon using chroot, or if a user or group
> -name does not exist on the destination system, then the numeric id
> +name does not exist on the destination system, then the numeric ID
>  from the source system is used instead.
>  
>  dit(bf(--timeout=TIMEOUT)) This option allows you to set a maximum IO
> @@ -867,7 +867,7 @@
>  using rsync with large files (several megabytes and up). Due to the nature
>  of rsync transfers, blocks of data are sent, then if rsync determines the
>  transfer was too fast, it will wait before sending the next data block. The
> -result is an average transfer rate equalling the specified limit. A value
> +result is an average transfer rate equaling the specified limit. A value
>  of zero specifies no limit.
>  
>  dit(bf(--write-batch=PREFIX)) Generate a set of files that can be
> @@ -1085,7 +1085,7 @@
>  bf(/etc/passwd) in the public section of the site.  Using
>  bf(--copy-unsafe-links) will cause any links to be copied as the file
>  they point to on the destination.  Using bf(--safe-links) will cause
> -unsafe links to be ommitted altogether.
> +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("..")

> -- 
> 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