flume-shell.1

'\" t
.\"     Title: flume-shell
.\"    Author: [see the "AUTHOR" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 11/09/2010
.\"    Manual: \ \&
.\"    Source: \ \&
.\"  Language: English
.\"
.TH "FLUME\-SHELL" "1" "11/09/2010" "\ \&" "\ \&"
.\" -----------------------------------------------------------------
.\" * 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"
flume-shell \- Flume shell
.SH "SYNOPSIS"
.sp
USAGE: \fBflume shell\fR [\-c <master>] [\-?] [\-e <cmd>] [\-q] [\-s <script>]
.SH "DESCRIPTION"
.sp
Start a Flume shell\&. This is a scriptable interface to communicate with the Flume master used for configuring a Flume system\&.
.SS "OPTIONS"
.PP
\fB\-?,\-\-help\fR
.RS 4
Output usage help
.RE
.PP
\fB\-c <master>[:<adminport[:<reportport>]]\fR
.RS 4
Connect to master on adminport (destination for commands) with reporting port reportport (for querying metrics reports aggregated at master)
.RE
.PP
\fB\-e <cmd>\fR
.RS 4
Run a single command, and then exit\&. Usually coupled with \-c\&.
.RE
.PP
\fB\-q\fR
.RS 4
Run in quiet mode \(em only print command results
.RE
.PP
\fB\-s <arg>\fR
.RS 4
Run a Flume shell script and then automatically exit\&.
.RE
.SS "EXIT STATUS"
.PP
\fB0\fR
.RS 4
Success
.RE
.PP
\fBn\fR
.RS 4
Command id of the last failed command\&.
.RE
.SH "FILES"
.PP
/etc/flume/conf
.RS 4
This symbolic link points to the currently active Flume configuration directory\&.
.RE
.PP
/etc/flume/conf/flume\-site\&.xml
.RS 4
This is the path to the currently deployed Flume site configuration\&.
.RE
.PP
/etc/init\&.d/flume\-node
.RS 4
Service script for starting and stopping a Flume Node
.RE
.PP
/etc/init\&.d/flume\-master
.RS 4
Service script for starting and stopping a Flume Master
.RE
.SH "ENVIRONMENT"
.sp
See flume(1) for more details\&.
.SH "EXAMPLES"
.sp
Execute an interactive Flume shell:
.sp
$ flume shell
.sp
Execute an interactive Flume shell that automatically connects to localhost:
.sp
$ flume shell \-c localhost
.sp
Execute a Flume shell that automatically connects to localhost and then sends the exec config foo console agentSink command:
.sp
$ flume shell \-c localhost \-e \fIexec config foo console agentSink\fR
.sp
Execute a Flume shell that quietly executes the commands in commands\&.fsh\&.
.sp
$ flume shell \-q \-s commands\&.fsh
.sp
Execute a Flume shell that automatically connects to localhost and is piped commands from the commands\&.fsh file\&.
.sp
$ cat commands\&.fsh > flume shell \-c localhost
.SH "AUTHOR"
.sp
See the Contributors site here: http://wiki\&.github\&.com/cloudera/flume/Contributors
.SH "RESOURCES"
.sp
Github web site and code repository: http://github\&.com/cloudera/flume/
.sp
Flume User guide: http://archive\&.cloudera\&.com/cdh/3/flume/UserGuide\&.html
.sp
Flume Cookbook: http://archive\&.cloudera\&.com/cdh/3/flume/Cookbook\&.html
.SH "COPYING"
.sp
Copyright (C) 2009\-2010 Cloudera, Inc\&.
.SH "SEE ALSO"
.sp
.if n \{\
.RS 4
.\}
.nf
flume(1), flume\-master(1), flume\-node(1), flume\-shell(1)
.fi
.if n \{\
.RE
.\}