/usr/share/doc/hovercraft/html/usage.html is in hovercraft 2.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Using Hovercraft! — Hovercraft! 2.1 documentation</title>
<link rel="stylesheet" href="_static/classic.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '2.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="Hovercraft! 2.1 documentation" href="index.html" />
<link rel="next" title="Making presentations" href="presentations.html" />
<link rel="prev" title="Introduction" href="introduction.html" />
</head>
<body role="document">
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="presentations.html" title="Making presentations"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="introduction.html" title="Introduction"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Hovercraft! 2.1 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="using-hovercraft">
<h1>Using Hovercraft!<a class="headerlink" href="#using-hovercraft" title="Permalink to this headline">¶</a></h1>
<p>You can either use Hovercraft! to generate the presentation as HTML in a
target directory, or you can let Hovercraft! serve the presentation from
its builtin webserver.</p>
<p>The latter have several benefits. One is that most webbrowsers will be very
reluctant to open popup-windows from pages served from the file system
this is a security measure which can be changed, but it’s easier to
just point the browser to <a class="reference external" href="http://localhost:8000">http://localhost:8000</a> instead.</p>
<p>The second benefit is that Hovercraft! will monitor the source files for the
presentation, and if they are modified Hovercraft! will generate the
presentation again automatically. That way you don’t have to run Hovercraft!
everytime you save a file, you only need to refresh the browser.</p>
<div class="section" id="parameters">
<h2>Parameters<a class="headerlink" href="#parameters" title="Permalink to this headline">¶</a></h2>
<p><code class="docutils literal"><span class="pre">hovercraft</span> <span class="pre">[-h]</span> <span class="pre">[-t</span> <span class="pre">TEMPLATE]</span> <span class="pre">[-c</span> <span class="pre">CSS]</span> <span class="pre">[-a]</span> <span class="pre">[-s]</span> <span class="pre">[-n]</span> <span class="pre">[-p</span> <span class="pre">PORT]</span> <span class="pre"><presentation></span> <span class="pre">[<targetdir>]</span></code></p>
<p>Positional arguments:</p>
<blockquote>
<div><dl class="docutils">
<dt><code class="docutils literal"><span class="pre"><presentation></span></code></dt>
<dd>The path to the reStructuredText presentation file.</dd>
<dt><code class="docutils literal"><span class="pre"><targetdir></span></code></dt>
<dd>The directory where the presentation is saved. Will be created if it
does not exist. If you do not specify a targetdir Hovercraft! will
instead start a webserver and serve the presentation from that server.</dd>
</dl>
</div></blockquote>
<p>Optional arguments:</p>
<blockquote>
<div><dl class="docutils">
<dt><code class="docutils literal"><span class="pre">-h,</span> <span class="pre">--help</span></code></dt>
<dd>Show this help.</dd>
<dt><code class="docutils literal"><span class="pre">-t</span> <span class="pre">TEMPLATE,</span> <span class="pre">--template</span> <span class="pre">TEMPLATE</span></code></dt>
<dd>Specify a template. Must be a .cfg file, or a directory with
a <code class="docutils literal"><span class="pre">template.cfg</span></code> file. If not given it will use a default template.</dd>
<dt><code class="docutils literal"><span class="pre">-c</span> <span class="pre">CSS,</span> <span class="pre">--css</span> <span class="pre">CSS</span></code></dt>
<dd>An additional CSS file for the presentation to use.
See also the <code class="docutils literal"><span class="pre">:css:</span></code> settings of the presentation.</dd>
<dt><code class="docutils literal"><span class="pre">-a,</span> <span class="pre">--auto-console</span></code></dt>
<dd>Open the presenter console automatically. This is useful when you are
rehearsing and making sure the presenter notes are correct.
You can also set this by having <code class="docutils literal"><span class="pre">:auto-console:</span> <span class="pre">true</span></code> first in the
presentation.</dd>
<dt><code class="docutils literal"><span class="pre">-s,</span> <span class="pre">--skip-help</span></code></dt>
<dd>Do not show the initial help popup.</dd>
<dt><code class="docutils literal"><span class="pre">-n,</span> <span class="pre">--skip-notes</span></code></dt>
<dd>Do not include presenter notes in the output.</dd>
<dt><code class="docutils literal"><span class="pre">-p</span> <span class="pre">PORT,</span> <span class="pre">--port</span> <span class="pre">PORT</span></code></dt>
<dd>The address and port that the server uses. Ex 8080 or
127.0.0.1:9000. Defaults to 0.0.0.0:8000.</dd>
</dl>
</div></blockquote>
</div>
<div class="section" id="built-in-templates">
<h2>Built in templates<a class="headerlink" href="#built-in-templates" title="Permalink to this headline">¶</a></h2>
<p>There are two templates that come with Hovercraft! One is called <code class="docutils literal"><span class="pre">default</span></code>
and will be used unless you specify a template. This is the template you will
use most of the time.</p>
<p>The second is called <code class="docutils literal"><span class="pre">simple</span></code> and it doesn’t have a presenter console. This
template is especially useful if you combine it with the <code class="docutils literal"><span class="pre">--skip-notes</span></code>
parameter to prepare a version of your presentation to be put online.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Using Hovercraft!</a><ul>
<li><a class="reference internal" href="#parameters">Parameters</a></li>
<li><a class="reference internal" href="#built-in-templates">Built in templates</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="introduction.html"
title="previous chapter">Introduction</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="presentations.html"
title="next chapter">Making presentations</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/usage.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="presentations.html" title="Making presentations"
>next</a> |</li>
<li class="right" >
<a href="introduction.html" title="Introduction"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">Hovercraft! 2.1 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2013-2016, Lennart Regebro.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.3.6.
</div>
</body>
</html>
|