'\" t
.\"     Title: gfarmbb
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 4 Oct 2019
.\"    Manual: Gfarm
.\"    Source: Gfarm
.\"  Language: English
.\"
.TH "GFARMBB" "1" "4 Oct 2019" "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"
gfarmbb \- start and stop Gfarm/BB (Gfarm for node\-local burst buffer)
.SH "SYNOPSIS"
.HP \w'\fBgfarmbb\fR\ 'u
\fBgfarmbb\fR [\fIoptions\fR] \fImode\fR
.SH "DESCRIPTION"
.PP
Gfarm/BB is an on\-demand user\-level file system for node\-local storages on compute nodes\&.
\fBgfarmbb\fR
starts a Gfarm/BB and stops it\&. The
\fImode\fR
should be start, stop or status\&. When the mode is start, it displays the environment variable that should be eval\*(Aqed to use Gfarm commands as follows;
.PP
% eval `gfarmbb start`
.PP
Basically, specify the same option for start, stop and status\&.
.SH "OPTIONS"
.PP
\fB\-mpi\fR \fImpirun_cmd\fR
.RS 4
sets up Gfarm/BB using MPI instead of gfarm\-prun\&.
\fImpirun_cmd\fR
is a command line to execute MPI that is used to configure and execute gfsd on each node\&. MPI command should execute 1 process per node\&. This option should be used with the \-conf option\&. When using this option, the \-e option and the \-h option are ignored\&.
.RE
.PP
\fB\-e\fR
.RS 4
excludes Gfmd node from file system nodes\&. Gfmd is executed on the node where gfarmbb is executed\&. With this option, gfsd is not executed on that node\&. This option expects there are N + 1 node allocations, and gfarmbb is executed on the last host in the hostfile\&. This option is available only for gfarmbb start\&.
.RE
.PP
\fB\-h\fR \fIhostfile\fR
.RS 4
specifies a
\fIhostfile\fR
that contains a list of hostnames of compute nodes\&.
.RE
.PP
\fB\-scr\fR \fIscratch_dir\fR
.RS 4
specifies a scratch directory on each compute node for Gfarm/BB\&. If it does not exist, it is created\&. This directory will be removed by gfarmbb stop\&. Default is /tmp/gfarmbb\-scratch\&.
.RE
.PP
\fB\-conf\fR \fIconf_dir\fR
.RS 4
specifies a scratch directory that can be shared among compute nodes to store temporal configuration files\&. If it does not exist, it is created\&. This directory will be removed by gfarmbb stop\&.
.RE
.PP
\fB\-l\fR
.RS 4
enables access to Gfarm/BB from login nodes\&. With this option, the Gfarm/BB configuration file $HOME/\&.gfarm2rc\-$ID is created in the home directory\&. ID consists of the hostname of the master compute node and the process ID\&. To access to Gfarm/BB, specify it by GFARM_CONFIG_FILE environment variable\&.
.RE
.PP
\fB\-L\fR \fIlog_dir\fR
.RS 4
specifies a log directory\&. If it does not exist, it is created\&. Log file names of gfmd and gfsd are gfmd\-$ID\&.log and gfsd\-$ID\&.log, respectively\&. Default directory is scratch_dir/log\&. This option is available only for gfarmbb start\&.
.RE
.PP
\fB\-m\fR \fImount_point\fR
.RS 4
When this option is specified, a Gfarm/BB is mounted at the specified mount point on each compute node\&. mount\&.gfarm2fs is required\&. This option is available only for gfarmbb start\&.
.RE
.PP
\fB\-p\fR \fIperiod\fR
.RS 4
specifies the period of a shared secret key in seconds for Gfarm/BB\&. This period should be longer than the job execution duration\&. Default is 86400 seconds (1 day)\&. This option is available only for gfarmbb start\&.
.RE
.PP
\fB\-c\fR
.RS 4
generates C\-shell commands\&. This option is available only for gfarmbb start\&.
.RE
.PP
\fB\-s\fR
.RS 4
generates Bourne shell commands\&. This option is available only for gfarmbb start\&. This is default\&.
.RE