/usr/share/doc/libaws-doc/html/resources.html is in libaws-doc 17.2.2017-2.
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 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 | <!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>10. Resources — AWS: Ada Web Server gpl-2017 documentation</title>
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: 'gpl-2017',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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="shortcut icon" href="_static/favicon.ico"/>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="11. Status page" href="status_page.html" />
<link rel="prev" title="9. Jabber" href="jabber.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="status_page.html" title="11. Status page"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="jabber.html" title="9. Jabber"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">AWS: Ada Web Server gpl-2017 documentation</a> »</li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="index.html">
<img class="logo" src="_static/adacore_transparent.png" alt="Logo"/>
</a></p>
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">10. Resources</a><ul>
<li><a class="reference internal" href="#building-resources">10.1. Building resources</a></li>
<li><a class="reference internal" href="#using-resources">10.2. Using resources</a></li>
<li><a class="reference internal" href="#stream-resources">10.3. Stream resources</a></li>
<li><a class="reference internal" href="#awsres-tool">10.4. awsres tool</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="jabber.html"
title="previous chapter">9. Jabber</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="status_page.html"
title="next chapter">11. Status page</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/resources.rst.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">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="resources">
<span id="id1"></span><h1>10. Resources<a class="headerlink" href="#resources" title="Permalink to this headline">¶</a></h1>
<span class="target" id="index-0"></span><p id="index-1"><cite>AWS</cite> support embedded resources. It means that it is possible to build
a fully self dependent executable. This is useful when distributing a
server. The server program contains the code but also the images (<cite>PNG</cite>,
<cite>JPEG</cite>, <cite>GIF</cite>), the templates, the <cite>HTML</cite> pages... more
generally any file the Web Server must serve to clients.</p>
<div class="section" id="building-resources">
<span id="id2"></span><h2>10.1. Building resources<a class="headerlink" href="#building-resources" title="Permalink to this headline">¶</a></h2>
<p id="index-2">To embbed the files into the executable you must build a resource
tree. This task is greatly simplified using <code class="file docutils literal"><span class="pre">AWSRes</span></code> tool. For
example let’s say that you want to build a simple server with a single
page containing some text and one PNG image. The text is handled
directly in the callback procedure and contain a reference to the
image <code class="file docutils literal"><span class="pre">logo.png</span></code>. To build the resource tree:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>$ awsres logo.png
</pre></div>
</div>
<p>This will create a set of packages whose root is the unit <cite>res</cite> by
default. The resource tree is created. See <a class="reference internal" href="#awsres-tool"><span class="std std-ref">awsres tool</span></a> for the
complete AWS’s usage description.</p>
<p><cite>awsres</cite> can also compress the resource files. This can be done
by using <cite>awsres</cite>‘s <cite>-z</cite> option. Compressed resources are
handled transparently. If the Web client supports compression the
resource is sent as-is otherwise a decompression stream will be
created for the resource to be decompressed on-the-fly while sending it.</p>
</div>
<div class="section" id="using-resources">
<span id="id3"></span><h2>10.2. Using resources<a class="headerlink" href="#using-resources" title="Permalink to this headline">¶</a></h2>
<p id="index-3">This is really the simplest step. The resource tree must be linked
with your executable, to do so you just have to ‘with’ the
resource tree root into one of your program unit. This will ensure
that the resource tree will be compiled and linked into the
executable. <cite>AWS</cite> and <cite>Templates_Parser know</cite> about resource
files and will pick them up if available.</p>
<p>Note that this is transparent to users. It is possible to build the
very same server based on standard files or resources files. The only
change in the code is to ‘with’ or not the resource tree.</p>
<p>Note that <cite>AWS</cite> supports only a single resource tree. If more
than one resource tree is included into a program only one will be
seen.</p>
</div>
<div class="section" id="stream-resources">
<span id="id4"></span><h2>10.3. Stream resources<a class="headerlink" href="#stream-resources" title="Permalink to this headline">¶</a></h2>
<p id="index-4">Users can build a response directly from a stream. In this case the
callback answer is built using <cite>AWS.Response.Stream</cite>. It creates a
resource object whose operations have been inherited from
<cite>AWS.Resource.Stream.Stream_Type</cite> and redefined by the user. So
the <cite>Read</cite> operation can dynamically create the result stream
data, the <cite>End_Of_File</cite> operation must returns <cite>True</cite> when the
stream data is out and so on. This feature is useful to let users completely
create and control dynamically <cite>AWS</cite>‘s response content.</p>
<p>See <a class="reference internal" href="apiref.html#aws-resources-streams"><span class="std std-ref">AWS.Resources.Streams</span></a>.</p>
</div>
<div class="section" id="awsres-tool">
<span id="id5"></span><h2>10.4. awsres tool<a class="headerlink" href="#awsres-tool" title="Permalink to this headline">¶</a></h2>
<p id="index-5"><cite>AWSRes</cite> is a tool to build resource files. It creates a root package
named <code class="file docutils literal"><span class="pre">res</span></code> by default and a child package for each resource
file:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">Usage</span><span class="p">:</span> <span class="n">awsres</span> <span class="p">[</span><span class="o">-</span><span class="n">hopqrRuz</span><span class="p">]</span> <span class="n">file1</span><span class="o">/</span><span class="n">dir1</span> <span class="p">[</span><span class="o">-</span><span class="n">uz</span><span class="p">]</span> <span class="p">[</span><span class="n">file2</span><span class="o">/</span><span class="n">dir2</span><span class="o">...</span><span class="p">]</span>
</pre></div>
</div>
<dl class="docutils">
<dt><em>-a</em></dt>
<dd>packages are named after the actual filenames</dd>
<dt><em>-h</em></dt>
<dd>Display help message.</dd>
<dt><em>-o</em></dt>
<dd>Specify the output directory, by default it is the current directory.</dd>
<dt><em>-p name</em></dt>
<dd>Append the specified prefix to the resource names.</dd>
<dt><em>-q</em></dt>
<dd>Quiet mode.</dd>
<dt><em>-R</em></dt>
<dd>Activate recursive behavior. In this mode <code class="file docutils literal"><span class="pre">awsres</span></code> will parse
recursively all subdirectories. If a directory is specified on the
command line then all files in this directory and sub-directories
will be added. If a file (possibly a pattern) is specificed on the
command line then only files matching in directroy and
sub-directories will be added.</dd>
<dt><em>-r name</em></dt>
<dd>Set the root unit name. Default is <cite>res</cite>.</dd>
<dt><em>-u</em></dt>
<dd>Add following files as uncompressed resources.</dd>
<dt><em>-z</em></dt>
<dd>Add following files as compressed resources.</dd>
</dl>
</div>
</div>
</div>
</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="status_page.html" title="11. Status page"
>next</a> |</li>
<li class="right" >
<a href="jabber.html" title="9. Jabber"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">AWS: Ada Web Server gpl-2017 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2002-2017, AdaCore.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.5.6.
</div>
</body>
</html>
|