head	1.4;
access;
symbols;
locks; strict;
comment	@# @;


1.4
date	93.05.30.05.24.56;	author aoki;	state Exp;
branches;
next	1.3;

1.3
date	93.03.11.23.09.19;	author aoki;	state Exp;
branches;
next	1.2;

1.2
date	93.03.11.22.53.32;	author aoki;	state Exp;
branches;
next	1.1;

1.1
date	93.03.11.22.53.03;	author aoki;	state Exp;
branches;
next	;


desc
@man page for icopy
@


1.4
log
@added note about filename/path limitations (ref to lobj man page)
@
text
@.\" This is -*-nroff-*-
.\" XXX standard disclaimer belongs here....
.\" $Header: /home2/aoki/master/src/ref/unix/RCS/icopy.1src,v 1.3 1993/03/11 23:09:19 aoki Exp aoki $
.TH ICOPY UNIX 03/11/93
.XA 1 "Icopy"
.SH NAME
icopy \- copy files between Unix and Inversion file systems
.SH SYNOPSIS
.BR icopy
.I direction
.BR "\-d"
dbname
.BR "\-s"
smgr
.in +5n
[\c
.BR "\-R" ]
[\c
.BR "\-a" ]
[\c
.BR "\-h"
host]
[\c
.BR "\-p"
portnum]
[\c
.BR "\-v" ]
.IR srcfile
.IR destfile
.in -5n
.SH DESCRIPTION
.BR Icopy
copies files between the Inversion file system and the \*(UU file
system.  This program is a
.IR libpq
client program, and the Inversion file system is a
transaction-protected file system used by the Sequoia 2000 research
project at UC Berkeley.  Inversion provides the same file system
services provided by the \*(UU fast file system, but does not support
an NFS interface at present.  In order to make it easier to use
Inversion, a suite of utility programs, including
.BR icopy ,
has been written to manage files.
.PP
The user specifies the host and port on which \*(PG is running, and
the database and storage manager to use for file storage.  The
.IR direction
of the copy specifies whether files should be copied from \*(UU
to Inversion
.RI ( in ),
or from Inversion to \*(UU
.RI ( out ).
The user also supplies two file names for the source and destination
of the copy.
.SH ARGUMENTS
The first five arguments listed here are required.
.TP 10
.IR direction
The direction of the copy.
If the direction is
.IR in ,
then the file is copied from \*(UU into Inversion.  If the direction
is
.IR out ,
then the file is copied out of Inversion to \*(UU.  The
.IR direction
argument affects the interpretation of the source and destination file
names, and may make some other flags (such as
.BR \-s )
optional (see below).  This argument must immediately follow the
program name.
.TP 10
.BR "\-d" " dbname"
The database to use for file storage.  The user should have permission
to create objects in
.IR dbname .
The database name must be supplied; there is no default.
.TP 10
.BR "\-s" " smgr"
Use
.IR smgr
as the
.BR "storage manager"
for the file.  Storage managers in \*(PG manage physical devices, so
this flag gives the user a way of controlling the device on which his
file should be stored.  If the direction of the copy is
.IR in ,
then the storage manager must be specified.  If the direction of the
copy is
.IR out ,
then the storage manager flag is optional, and is ignored if it is
supplied.
.IP
The list of available storage managers may be obtained by typing
.(C
icopy
.)C
with no options; the resulting usage message includes a list of
storage managers supported.
.TP 10
.IR srcfile
The file from which to copy.  If
.IR direction
is
.IR in ,
then this is the name of a file or directory on the \*(UU file system.
If
.IR direction
is
.IR out ,
then this is the name of a file or directory on the Inversion file
system.
.IP
If
.IR srcfile
is a directory and the
.BR "\-R"
flag is supplied, then the tree rooted at
.I srcfile
is copied.  It is an error to specify a directory to copy without
supplying the
.BR "\-R"
flag.
.TP 10
.IR destfile
The file to which to copy.  If
.IR direction
is
.IR in ,
then this is the name of an Inversion file or directory.
If
.IR direction
is
.IR out ,
then
.IR destfile
is the name of a \*(UU file or directory.
.IP
If
.IR destfile
already exists and is a directory, then
.IR srcfile
will be created in the directory
.IR destfile .
.PP
The following arguments are optional.
.TP 10
.BR "\-h" " host"
Specifies the hostname of the machine on which the 
.IR postmaster
is running.  Defaults to the name of the local host, or the value of
the
.SM PGHOST
environment variable (if set).
.TP 10
.BR "\-p" " port"
Specifies the Internet TCP port on which the
.IR postmaster
is listening for connections.  Defaults to 4321, or the value of the
.SM PGPORT
environment variable (if set).
.TP 10
.BR "\-R"
Copy a directory tree recursively.  Rather than copying a single file,
the tree rooted at
.IR srcfile
is copied to a tree rooted at
.IR destfile .
.TP 10
.BR "\-a"
Copy all files,
including those beginning with a dot.
This flag is useful only in conjunction with
.BR \-R .
Normally,
recursive copies of a directory tree will not copy files
or directories whose names begin with a dot.
.TP 10
.BR "\-v"
Turn verbose mode on.
.BR Icopy
will report its progress as it moves files to or from Inversion.
.SH EXAMPLES
The command
.(C
icopy in \-h myhost \-p 4321 \-d mydb \-s d /vmunix /inv_vmunix
.)C
copies the \*(UU file \*(lq/vmunix\*(rq to the Inversion file
\*(lq/inv_vmunix\*(rq.
The Inversion file is stored in the database \*(lqmydb\*(rq by the
\*(PG backend running on machine \*(lqmyhost\*(rq and listening on
port number 4321.
.PP
The command
.(C
icopy out \-h myhost \-p 4321 \-d mydb /inv_vmunix /vmunix.dup
.)C
copies it back out again, putting the copy in the \*(UU file
\*(lq/vmunix.dup\*(rq.
.SH BUGS
The \*(PG file system code should support operations via NFS, so this
program actually has no right to exist.
.PP
See
.IR "introduction" "(large objects)"
for filename and path limitations imposed by the Inversion file system.
@


1.3
log
@whoops.  fixed some italic/bold mixups.
@
text
@d3 1
a3 1
.\" $Header: /home2/aoki/master/src/ref/unix/RCS/icopy.1src,v 1.2 1993/03/11 22:53:32 aoki Exp aoki $
d203 4
@


1.2
log
@changed to pg manual style
@
text
@d3 1
a3 1
.\" $Header$
d9 1
a9 1
.B icopy
d11 1
a11 1
.IR "\-d"
d13 1
a13 1
.IR "\-s"
d17 1
a17 1
.IR "\-R" ]
d19 1
a19 1
.IR "\-a" ]
d21 1
a21 1
.IR "\-h"
d24 1
a24 1
.IR "\-p"
d27 1
a27 1
.IR "\-v" ]
@


1.1
log
@Initial revision
@
text
@d1 5
a5 4
.\" $Copyright:	$
...
.V= $Header: /private/mao/postgres/test/postfs/RCS/icopy.1P,v 1.3 1992/09/01 01:52:08 mao Exp $
.TH ICOPY 1 "\*(V)" "POSTGRES"
d11 20
a30 16
[
.I "\-h host"
] [
.I "\-p portnum"
]
.I "\-d dbname"
.I "\-s smgr"
[
.I "\-a"
] [ 
.I "\-v"
] [ 
.I "\-R"
]
.I srcfile
.I destfile
d32 11
a42 14
.B Icopy
copies files between the Inversion file system and the Unix file system.
This program is a \s-2POSTGRES\s0
.I libpq
client program,
and the Inversion file system is a transaction-protected file
system used by the Sequoia 2000 research project at UC Berkeley.
Inversion provides the same file system services provided by
the Unix fast file system,
but does not support an NFS interface at present.
In order to make it easier to use Inversion,
a suite of utility programs,
including
.IR icopy ,
d45 4
a48 6
The user specifies the host and port on which \s-2POSTGRES\s0 is
running,
and the database and storage manager to use for file storage.
The
.i direction
of the copy specifies whether files should be copied from Unix
d50 5
a54 4
(\fIin\fP),
or from Inversion to Unix (\fIout\fP).
The user also supplies two file names,
for the source and destination of the copy.
d56 1
d58 1
a58 1
.I direction
d61 15
a75 32
.BR in ,
then the file is copied from Unix into Inversion.
If the direction is
.BR out ,
then the file is copied out of Inversion to Unix.
The
.I direction
argument affects the interpretation of the source and destination
file names,
and may make some other flags (such as
.IR \-s )
optional
(see below).
This argument must immediately follow the program name.
.TP 10
.I "\-h host"
The host on which the \s-2POSTGRES\s0
.B postmaster
is running.
If the host is not specified,
it is be obtained from the environment variable PGHOST.
.TP 10
.I "\-p port"
The TCP port number on which to establish a connection to the
\s-2POSTGRES\s0
.BR postmaster .
If the port number is not supplied,
it is obtained from the environment variable PGPORT.
.TP 10
.I "\-d dbname"
The database to use for file storage.
The user should have permission to create objects in
d77 1
a77 2
The database name must be supplied;
there is no default.
d79 1
a79 1
.I "\-s smgr"
d81 1
a81 1
.I smgr
d83 4
a86 6
.B "storage manager"
for the file.
Storage managers in \s-2POSTGRES\s0 manage physical devices,
so this flag gives the user a way of controlling the device
on which his file should be stored.
If the direction of the copy is
d88 2
a89 2
then the storage manager must be specified.
If the direction of the copy is
d91 3
a93 3
then the storage manager flag is optional,
and is ignored if it is supplied.
.IP ""
d95 9
a103 33
.RS
.B icopy
.RE
with no options;
the resulting usage message includes a list of storage managers
supported.
.TP 10
.I "\-R"
Copy a directory tree recursively.
Rather than copying a single file,
the tree rooted at
.I srcfile
is copied to a tree rooted at
.I destfile .
.TP 10
.I "\-a"
Copy all files,
including those beginning with a dot.
This flag is useful only in conjunction with
.IR \-R .
Normally,
recursive copies of a directory tree will not copy files
or directories whose names begin with a dot.
.TP 10
.I "\-v"
Turn verbose mode on.
.B Icopy
will report its progress as it moves files to or from Inversion.
.TP 10
.I srcfile
The file from which to copy.
If
.I direction
d106 1
a106 1
then this is the name of a file or directory on the Unix file system.
d108 1
a108 1
.I direction
d111 12
a122 13
then this is the name of a file or directory on the Inversion file system.
.IP ""
If
.I srcfile
is a directory
and the
.I \-R
flag is supplied,
then the tree rooted at
.I srcfile
is copied.
It is an error to specify a directory to copy without supplying the
.I \-R
d125 3
a127 4
.I destfile
The file to which to copy.
If
.I direction
d132 1
a132 1
.I direction
d136 7
a142 8
.I destfile
is the name of a Unix file or directory.
.IP ""
If
.I destfile
already exists and is a directory,
then
.I srcfile
d145 38
d185 1
a185 2
.RS
.PP
d187 6
a192 1
.RE
a193 5
copies the Unix file /vmunix to the Inversion file /inv_vmunix.
The Inversion file is stored in the database mydb
by the \s-2POSTGRES\s0 backend running on machine myhost
and listening on port number 4321.
.pp
d195 1
a195 2
.RS
.PP
d197 3
a199 4
.RE
.PP
copies it back out again,
putting the copy in the Unix file /vmunix.dup.
d201 2
a202 2
The \s-2POSTGRES\s0 file system code should support operations via NFS,
so this program actually has no right to exist.
@