.\"  $HeadURL$ $LastChangedRevision$
.\"
.TH ALIGN 1 "SPPSYM_RELEASE_DATE_MAN"
.ne 5
.SH NAME
align \- align my home directory at ESO and home
.br
.ne 5
.SH SYNOPSIS
.B align
[
.B \-V
|
.B \-\-version
] [
.B \-v
|
.B \-\-verbose
|
.B \-d
.I level
|
.B \-\-debug=\fIlevel
] [
.B \-h
|
.B \-\-help
] [
.B \-p
|
.B \-\-list\-paths
] 
{
.B \-\-push
| 
.B \-\-pull
}
{
.B \-y
|
.B \-n
|
.B \-\-simulate
}
.I remotehost
.br
.ne 5
.SH DESCRIPTION
This manual page documents version SPPSYM_RELEASE_ID of
.B align\fR.
.PP
.B Align
is a wrapper script for
.B rsync\fR(1),
which I use for aligning my home directory between home and ESO.
.PP
It never deletes files; it only ever copies them.
.ne 5
.SH CONFIGURATION
.B Align
requires 
.B ssh\fR(1)
access (with or without password or private key password prompting).
.br
.ne 5
.SH OPTIONS
.TP 25
.B \-d \fIlevel\fR, \fB\-\-debug=\fIlevel\fR
Determines how verbose
.B mkfad
will be. The message types displayed for the different values of 
.I level
are as follows:
.RS 25
.TP 5
.B 0
internal errors only
.TP
.B 1
internal errors and normal errors 
.TP
.B 2
internal errors, normal errors and warnings
.TP 
.B 3
internal errors, normal errors, warnings and informational messages
.TP 
.B >3
all the above plus application-specific debug messages.
.RE
.TP 25
.B \-h\fR, \fB\-\-help
Displays a brief usage message.
.TP
.B \-n\fR, \fB\-\-simulate
.B Align
will only simulate what it would do; no files will be transferred.
.TP
.B \-p\fR, \fB\-\-list\-paths
List the compiled-in paths of various files and directories that
.B mkfad
uses.
.TP
.B \-\-pull
.B Align
is to pull files from 
.I remotehost
to the local host.
.TP
.B \-\-push
.B Align
is to push files from 
the local host to
.I remotehost\fR.
.TP 
.B \-v\fR, \fB\-\-verbose
Equivalent to
.B \-d 3\fR.
.TP
.B \-V\fR, \fB\-\-version
Print the program's version number and exit.
.TP
.B \-y
.B Align
will copy files instead of just simulating.
.br
.ne 5
.SH EXIT STATUS
On success
.B align
returns zero. On failure it returns non-zero and displays a diagnostic
message.
.br
.ne 5
.SH FILES
None.
.br
.ne 5
.SH ENVIRONMENT VARIABLES
None.
.br
.ne 5
.SH EXAMPLES
The following command sequence is what I normally run from ESO:
.IP
.nf
.fam C
.B script push.log
.B align --push -n -v dione.no-ip.org
.B exit
.B more push.log
.B rm ...
.B rm push.log
.B align --push -y -v dione.no-ip.org
.B script pull.log
.B align --pull -n -v dione.no-ip.org
.B exit
.B more pull.log
.B ssh dione.no-ip.org rm ...
.B rm pull.log
.B align --pull -y -v dione.no-ip.org
.fam T
.fi
.br
.ne 5
.SH CAVEATS
None.
.br
.ne 5
.SH SEE ALSO
rsync(1), ssh(1)
.br
.ne 5
.SH AUTHOR
SPPSYM_AUTHOR_NAME <SPPSYM_AUTHOR_EMAIL>
.br
.ne 5
.SH COPYRIGHT & DISTRIBUTION POLICY
Copyright (C) 2001-SPPSYM_RELEASE_YEAR SPPSYM_AUTHOR_NAME
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
.PP
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.