/usr/share/doc/festival-doc/html/Basic-command-line-options.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Basic command line options (Festival Speech Synthesis System)</title>

<meta name="description" content="Basic command line options (Festival Speech Synthesis System)">
<meta name="keywords" content="Basic command line options (Festival Speech Synthesis System)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html#Top" rel="start" title="Top">
<link href="Index.html#Index" rel="index" title="Index">
<link href="Index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Quick-start.html#Quick-start" rel="up" title="Quick start">
<link href="Simple-command-driven-session.html#Simple-command-driven-session" rel="next" title="Simple command driven session">
<link href="Quick-start.html#Quick-start" rel="prev" title="Quick start">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<a name="Basic-command-line-options"></a>
<div class="header">
<p>
Next: <a href="Simple-command-driven-session.html#Simple-command-driven-session" accesskey="n" rel="next">Simple command driven session</a>, Up: <a href="Quick-start.html#Quick-start" accesskey="u" rel="up">Quick start</a> &nbsp; [<a href="Index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Basic-command-line-options-1"></a>
<h3 class="section">7.1 Basic command line options</h3>

<a name="index-command-line-options"></a>
<p>Festival&rsquo;s basic calling method is as
</p>
<div class="lisp">
<pre class="lisp">festival [options] file1 file2 ...
</pre></div>

<p>Options may be any of the following
</p>
<dl compact="compact">
<dt><code>-q</code></dt>
<dd><p>start Festival without loading <samp>init.scm</samp> or user&rsquo;s
<samp>.festivalrc</samp>
</p></dd>
<dt><code>-b</code></dt>
<dt><code>--batch</code></dt>
<dd><a name="index-batch-mode"></a>
<p>After processing any file arguments do not become interactive
</p></dd>
<dt><code>-i</code></dt>
<dt><code>--interactive</code></dt>
<dd><a name="index-interactive-mode"></a>
<p>After processing file arguments become interactive.  This option overrides
any batch argument.
</p></dd>
<dt><code>--tts</code></dt>
<dd><a name="index-tts-mode-1"></a>
<p>Treat file arguments in text-to-speech mode, causing them to be
rendered as speech rather than interpreted as commands.  When selected
in interactive mode the command line edit functions are not available
</p></dd>
<dt><code>--command</code></dt>
<dd><a name="index-command-mode-1"></a>
<p>Treat file arguments in command mode.  This is the default.
</p></dd>
<dt><code>--language LANG</code></dt>
<dd><a name="index-language-specification"></a>
<p>Set the default language to <var>LANG</var>.  Currently <var>LANG</var> may be
one of <code>english</code>, <code>spanish</code> or <code>welsh</code> (depending on
what voices are actually available in your installation).
</p></dd>
<dt><code>--server</code></dt>
<dd><p>After loading any specified files go into server mode.  This is
a mode where Festival waits for clients on a known port (the
value of <code>server_port</code>, default is 1314).  Connected
clients may send commands (or text) to the server and expect
waveforms back. See <a href="Server_002fclient-API.html#Server_002fclient-API">Server/client API</a>.  Note server mode
may be unsafe and allow unauthorised access to your
machine, be sure to read the security recommendations in
<a href="Server_002fclient-API.html#Server_002fclient-API">Server/client API</a>
</p></dd>
<dt><code>--script scriptfile</code></dt>
<dd><a name="index-script-files"></a>
<a name="index-Festival-script-files"></a>
<p>Run scriptfile as a Festival script file.  This is similar to
to <code>--batch</code> but it encapsulates the command line arguments into
the Scheme variables <code>argv</code> and <code>argc</code>, so that Festival
scripts may process their command line arguments just like
any other program.  It also does not load the the basic initialisation
files as sometimes you may not want to do this.  If you wish them,
you should copy the loading sequence from an example Festival
script like <samp>festival/examples/saytext</samp>.
</p></dd>
<dt><code>--heap NUMBER</code></dt>
<dd><a name="index-heap-size"></a>
<a name="index-Scheme-heap-size"></a>
<p>The Scheme heap (basic number of Lisp cells) is of a fixed size and
cannot be dynamically increased at run time (this would complicate
garbage collection).  The default size is 210000 which seems to be more
than adequate for most work.  In some of our training experiments where
very large list structures are required it is necessary to increase
this.  Note there is a trade off between size of the heap and time it
takes to garbage collect so making this unnecessarily big is not a good
idea.  If you don&rsquo;t understand the above explanation you almost
certainly don&rsquo;t need to use the option.
</p></dd>
</dl>
<p>In command mode, if the file name starts with a left parenthesis, the
name itself is read and evaluated as a Lisp command.  This is often
convenient when running in batch mode and a simple command is necessary
to start the whole thing off after loading in some other specific files.
</p>
<hr>
<div class="header">
<p>
Next: <a href="Simple-command-driven-session.html#Simple-command-driven-session" accesskey="n" rel="next">Simple command driven session</a>, Up: <a href="Quick-start.html#Quick-start" accesskey="u" rel="up">Quick start</a> &nbsp; [<a href="Index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Index.html#Index" title="Index" rel="index">Index</a>]</p>
</div>



</body>
</html>
festival-doc 1:2.5.0-1 / usr / share / doc / festival-doc / html / Basic-command-line-options.html
