'\" t
.\"     Title: gfprep
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 14 Jan 2017
.\"    Manual: Gfarm
.\"    Source: Gfarm
.\"  Language: English
.\"
.TH "GFPREP" "1" "14 Jan 2017" "Gfarm" "Gfarm"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
gfprep \- replicate Gfarm files in parallel
.SH "SYNOPSIS"
.HP \w'\fBgfprep\fR\ 'u
\fBgfprep\fR [\-nqvdpPBU] [\-mx] [\-X\ \fIregexp\fR] [\-S\ \fIsource\-domainname\fR] [\-h\ \fIsource\-hostfile\fR] [\-D\ \fIdestination\-domainname\fR] [\-H\ \fIdestination\-hostfile\fR] [\-j\ \fInum\-of\-processes\fR] [\-J\ \fInum\-of\-processes\fR] [\-M\ \fItotal\-byte\fR] [\-z\ \fIminimum\-byte\fR] [\-Z\ \fImaximum\-byte\fR] [\-w\ \fIway\-of\-scheduling\fR] [\-W\ \fIkilobytes\-for\-threshold\fR] [\-s\ \fIKB/s\-to\-simulate\fR] [\-F\ \fInum\-for\-readahead\fR] [\-I\ \fIsec\-to\-update\fR] [\-N\ \fInum\-of\-replicas\fR] \fIpath\fR
.SH "DESCRIPTION"
.PP
\fBgfprep\fR
creates replicas of Gfarm files in parallel\&.
.PP
When the
\fIpath\fR
specifies a directory, files under the directory will be replicated recursively\&.
.PP
\fIPath\fR
can be specified by a Gfarm URL or a path on a mount point of gfarm2fs\&.
.PP
A set of source/destination hosts can be specified by a domain name and/or a hostlist file\&. When both a domain name and a hostlist file are specified, a set of hosts is determined by both conditions\&. When a set of source hosts is specified, only files stored on the source hosts are replicated\&.
.PP
Less busy file system nodes will be selected for source or destination\&. The maximum number of parallel replications/copies per host is the number of CPUs\&. Please see the manual page of
\fBgfhost\fR
for information about the number of CPUs\&.
.PP
\fBgfprep\fR
also retrieves the directory entries in parallel\&.
.SH "GFPREP OPTIONS"
.PP
These are options only for
\fBgfprep\fR\&.
.PP
\fB\-N\fR \fInum\-of\-replicas\fR
.RS 4
Specifies the required number of file replicas\&. If there are a sufficient number of replicas in the destination hosts, neither any copying nor any removal will be done\&.
.sp
If this option is not specified, \-N 1 is assumed\&.
.RE
.PP
\fB\-x\fR
.RS 4
Removes extra file replicas when a set of destination nodes has more file replicas than specified by the \-N option\&.
.RE
.PP
\fB\-m\fR
.RS 4
Migrates file replicas from a set of source nodes to destination nodes\&. When specifying twice like \-mm, it leaves the source file replica\&.
.sp
This option requires at least one of \-S, \-h, \-D, and \-H options\&.
.sp
This option and the \-N option are mutually exclusive\&.
.RE
.SH "COMMON OPTIONS"
.PP
There are several common options with
\fBgfprep\fR\&. (see man
\fBgfpcopy\fR)
.SH "EXAMPLES"
.PP
To replicate files under the directory recursively\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ gfprep \-N 3 gfarm:///dir
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
$ cd /mnt/gfarm2fs
$ gfprep \-N 3 dir
.fi
.if n \{\
.RE
.\}
.PP
To replicate a file or remove surplus replicas of the file\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ gfprep \-N 3 \-x gfarm:///dir/file
.fi
.if n \{\
.RE
.\}
.PP
To migrate replicas from gfsd1\&.example\&.com to other nodes\&.
.sp
.if n \{\
.RS 4
.\}
.nf
$ gfprep \-m \-S gfsd1\&.example\&.com gfarm:///
.fi
.if n \{\
.RE
.\}
.SH "NOTES"
.PP
When the \-L or \-m option is not specified, a source node is not always selected within a set of specified source file system nodes\&.
.PP
It is better to execute
\fBgfprep\fR
command near the metadata server\&. When you need to execute
\fBgfprep\fR
command far from the metadata server, increase the parallelism by the \-j and \-J options\&.
.SH "SEE ALSO"
.PP
\fBgfrep\fR(1),
\fBgfpcopy\fR(1),
\fBgfhost\fR(1),
\fBgfarm2.conf\fR(5)