rsync-backup.in: Add `-n' option to usage synopsis.

[rsync-backup] / rsync-backup.8

diff --git a/rsync-backup.8 b/rsync-backup.8
index 714b63f..0710158 100644 (file)
--- a/rsync-backup.8
+++ b/rsync-backup.8
@@ -158,7 +158,9 @@ will avoid inefficient and pointless messing about
 in this case.
 This command clears the
 .B like
 in this case.
 This command clears the
 .B like

-list, and resets the retention policy to its default (i.e., the to
+list, the remote
+.B user
+name, and resets the retention policy to its default (i.e., the to

 policy defined prior to the first
 .B host
 command).
 policy defined prior to the first
 .B host
 command).


@@ -251,6 +253,15 @@ for subsequent backups.  Some snapshot types require additional
 arguments, which may be supplied here.  This command clears the
 .B retry
 counter.
 arguments, which may be supplied here.  This command clears the
 .B retry
 counter.

+.TP
+.BI "user " name
+Specify the user name on the remote host.  Without this, calls to
+.BR ssh (1)
+and
+.BR rsync (1)
+won't specify any user name, so the default (probably from the
+.BR ssh_config (5)
+file) will apply.

 .SS Configuration variables
 The following shell variables may be overridden by the configuration
 file.
 .SS Configuration variables
 The following shell variables may be overridden by the configuration
 file.


@@ -465,7 +476,8 @@ when no backup is running.
 .PP
 So don't use those names for your hosts.
 .PP
 .PP
 So don't use those names for your hosts.
 .PP

-The next layer down contains a directory for each filesystem on the given host.
+The next layer down contains a directory for each filesystem on the
+given host.

 .PP
 The bottom layer contains a directory for each dump of that filesystem,
 named with the date at which the dump was started (in ISO8601
 .PP
 The bottom layer contains a directory for each dump of that filesystem,
 named with the date at which the dump was started (in ISO8601