.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "RIVESCRIPT 1p"
.TH RIVESCRIPT 1p "2016-10-31" "perl v5.24.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
rivescript \- A command line frontend to the Perl RiveScript interpreter.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  $ rivescript [options] [path to RiveScript documents]
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is a command line front-end to the RiveScript interpreter. This script
obsoletes the old \f(CW\*(C`rsdemo\*(C'\fR, and can also be used non-interactively by third
party programs. To that end, it supports a variety of input/output and session
handling methods.
.PP
If no RiveScript document path is given, it will default to the example brain
that ships with the RiveScript module, which is based on the Eliza bot.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\-\-debug, \-d" 4
.IX Item "--debug, -d"
Enables debug mode. This will print all debug data from RiveScript to your
terminal. If you'd like it to log to a file instead, use the \f(CW\*(C`\-\-log\*(C'\fR option
instead of \f(CW\*(C`\-\-debug\*(C'\fR.
.IP "\-\-log \s-1FILE\s0" 4
.IX Item "--log FILE"
Enables debug mode and prints the debug output to \f(CW\*(C`FILE\*(C'\fR instead of to your
terminal.
.IP "\-\-json, \-j" 4
.IX Item "--json, -j"
Runs \f(CW\*(C`rivescript\*(C'\fR in \s-1JSON\s0 mode, for running the script in a non-interactive
way (for example, to use RiveScript in a programming language that doesn't have
a native RiveScript library). See \*(L"\s-1JSON\s0 Mode\*(R" for details.
.IP "\-\-data \s-1JSON_DATA\s0" 4
.IX Item "--data JSON_DATA"
When using the \f(CW\*(C`\-\-json\*(C'\fR option, you can provide the \s-1JSON\s0 input message as a
command line argument with the \f(CW\*(C`\-\-data\*(C'\fR option. If not provided, then the
\&\s-1JSON\s0 data will be read from standard input instead. This option is helpful,
therefore, if you don't want to open a two-way pipe, but rather pass the message
as a command line argument and just read the response from standard output.
See \*(L"\s-1JSON\s0 Mode\*(R" for more details.
.IP "\-\-listen, \-l [\s-1ADDRESS:\s0]PORT" 4
.IX Item "--listen, -l [ADDRESS:]PORT"
Runs \f(CW\*(C`rivescript\*(C'\fR in \s-1TCP\s0 mode, for running the script as a server daemon.
If an address isn't specified, it will bind to \f(CW\*(C`localhost\*(C'\fR. See
\&\*(L"\s-1TCP\s0 Mode\*(R" for details.
.IP "\-\-strict, \-\-nostrict" 4
.IX Item "--strict, --nostrict"
Enables strict mode for the RiveScript parser. It's enabled by default, use
\&\f(CW\*(C`\-\-nostrict\*(C'\fR to disable it. Strict mode prevents the parser from continuing
when it finds a syntax error in the RiveScript documents.
.IP "\-\-depth=50" 4
.IX Item "--depth=50"
Override the default recursion depth limit. This controls how many times
RiveScript will recursively follow redirects to other replies. The default is
\&\f(CW50\fR.
.IP "\-\-utf8, \-u" 4
.IX Item "--utf8, -u"
Use the \s-1UTF\-8\s0 option in RiveScript. This allows triggers to contain foreign
characters and relaxes the filtering of user messages. This is not enabled
by default!
.IP "\-\-help" 4
.IX Item "--help"
Displays this documentation in your terminal.
.SH "USAGE"
.IX Header "USAGE"
.SS "Interactive Mode"
.IX Subsection "Interactive Mode"
This is the default mode used when you run \f(CW\*(C`rivescript\*(C'\fR without specifying
another mode. This mode behaves similarly to the old \f(CW\*(C`rsdemo\*(C'\fR script and lets
you chat one-on-one with your RiveScript bot.
.PP
This mode can be used to test your RiveScript bot. Example:
.PP
.Vb 1
\&  $ rivescript /path/to/rs/files
.Ve
.SS "\s-1JSON\s0 Mode"
.IX Subsection "JSON Mode"
This mode should be used when calling from a third party program. In this mode,
data that enters and leaves the script are encoded in \s-1JSON.\s0
.PP
Example:
.PP
.Vb 1
\&  $ rivescript \-\-json /path/to/rs/files
.Ve
.PP
The format for incoming \s-1JSON\s0 data is as follows:
.PP
.Vb 7
\&  {
\&    "username": "localuser",
\&    "message":  "Hello bot!",
\&    "vars": {
\&      "name": "Aiden"
\&    }
\&  }
.Ve
.PP
Here, \f(CW\*(C`username\*(C'\fR is a unique name for the user, \f(CW\*(C`message\*(C'\fR is their message to
the bot, and \f(CW\*(C`vars\*(C'\fR is a hash of any user variables your program might be
keeping track of (such as the user's name and age).
.PP
The response from \f(CW\*(C`rivescript\*(C'\fR will look like the following:
.PP
.Vb 7
\&  {
\&    "status": "ok",
\&    "reply":  "Hello, human!",
\&    "vars": {
\&      "name": "Aiden"
\&    }
\&  }
.Ve
.PP
Here, \f(CW\*(C`status\*(C'\fR will be \f(CW"ok"\fR or \f(CW"error"\fR, \f(CW\*(C`reply\*(C'\fR is the bot's response to
your message, and \f(CW\*(C`vars\*(C'\fR is a hash of the current variables for the user (so
that your program can save them somewhere).
.PP
\fIStandard Input or Data\fR
.IX Subsection "Standard Input or Data"
.PP
By default, \s-1JSON\s0 mode will read from standard input to receive your \s-1JSON\s0
message. As an alternative to this, you can provide the \f(CW\*(C`\-\-data\*(C'\fR option to
\&\f(CW\*(C`rivescript\*(C'\fR to present the incoming \s-1JSON\s0 data as a command line argument.
.PP
This may be helpful if you don't want to open a two-way pipe to \f(CW\*(C`rivescript\*(C'\fR,
and would rather pass your input as a command line argument and simply read
the response from standard output.
.PP
Example:
.PP
.Vb 2
\&  $ rivescript \-\-json \-\-data \*(Aq{"username": "localuser", "message": "hello" }\*(Aq \e
\&    /path/to/rs/files
.Ve
.PP
This will cause \f(CW\*(C`rivescript\*(C'\fR to print its \s-1JSON\s0 response to standard output
and exit. You can't have a stateful session using this method.
.PP
\fIEnd of Message\fR
.IX Subsection "End of Message"
.PP
There are two ways you can use the \s-1JSON\s0 mode: \*(L"fire and forget,\*(R" or keep a
stateful session open.
.PP
In \*(L"fire and forget,\*(R" you open the program, print your \s-1JSON\s0 input and send the
\&\s-1EOF\s0 signal, and then \f(CW\*(C`rivescript\*(C'\fR sends you the \s-1JSON\s0 response and exits.
.PP
In a stateful session mode, you must send the text \f(CW\*(C`_\|_END_\|_\*(C'\fR on a line by
itself after you finish sending your \s-1JSON\s0 data. Then \f(CW\*(C`rivescript\*(C'\fR will
process it, return its \s-1JSON\s0 response and then also say \f(CW\*(C`_\|_END_\|_\*(C'\fR at the end.
.PP
Example:
.PP
.Vb 6
\&  {
\&    "username": "localuser",
\&    "message": "Hello bot!",
\&    "vars": {}
\&  }
\&  _\|_END_\|_
.Ve
.PP
And the response:
.PP
.Vb 6
\&  {
\&    "status": "ok",
\&    "reply": "Hello, human!",
\&    "vars": {}
\&  }
\&  _\|_END_\|_
.Ve
.PP
This way you can reuse the same pipe to send and receive multiple messages.
.SS "\s-1TCP\s0 Mode"
.IX Subsection "TCP Mode"
\&\s-1TCP\s0 Mode will make \f(CW\*(C`rivescript\*(C'\fR listen on a \s-1TCP\s0 socket for incoming
connections. This way you can connect to it from a different program (for
example, a \s-1CGI\s0 script or a program written in a different language).
.PP
Example:
.PP
.Vb 1
\&  $ rivescript \-\-listen localhost:2001
.Ve
.PP
\&\s-1TCP\s0 Mode behaves similarly to \*(L"\s-1JSON\s0 Mode\*(R"; the biggest difference is that
it will read and write using a \s-1TCP\s0 socket instead of standard input and
output. Unlike \s-1JSON\s0 Mode, however, \s-1TCP\s0 Mode \fIalways\fR runs in a stateful
way (the \s-1JSON\s0 messages must end with the text "\f(CW\*(C`_\|_END_\|_\*(C'\fR" on a line by
itself). See \*(L"End of Message\*(R".
.PP
If the \f(CW\*(C`_\|_END_\|_\*(C'\fR line isn't found after 20 lines of text are read from
the client, it will give up and send the client an error message (encoded
in \s-1JSON\s0) and disconnect it.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
RiveScript, the Perl RiveScript interpreter.
.SH "AUTHOR"
.IX Header "AUTHOR"
Noah Petherbridge, http://www.kirsle.net
.SH "LICENSE"
.IX Header "LICENSE"
.Vb 2
\&  RiveScript \- Rendering Intelligence Very Easily
\&  Copyright (C) 2012 Noah Petherbridge
\&  
\&  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.
\&  
\&  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.
\&  
\&  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., 59 Temple Place, Suite 330, Boston, MA  02111\-1307  USA
.Ve