You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 

109 lines
6.0 KiB

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>anypaper_command</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="anypaper Reference Manual">
<link rel="up" href="ch01.html" title="anyPaper Classes">
<link rel="prev" href="anypaper-anypaper-window.html" title="AnypaperWindow">
<link rel="next" href="object-tree.html" title="Object Hierarchy">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="anypaper-anypaper-window.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">anypaper Reference Manual</th>
<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#anypaper-anypaper-command.synopsis" class="shortcut">Top</a>
 | 
<a href="#anypaper-anypaper-command.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="anypaper-anypaper-command"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="anypaper-anypaper-command.top_of_page"></a>anypaper_command</span></h2>
<p>anypaper_command — command-line control functions</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="anypaper-anypaper-command.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="anypaper-anypaper-command.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;anypaper_preview.h&gt;
#define <a class="link" href="anypaper-anypaper-command.html#LICENSE:CAPS" title="LICENSE">LICENSE</a>
<span class="returnvalue">void</span> <a class="link" href="anypaper-anypaper-command.html#show-version-and-exit" title="show_version_and_exit ()">show_version_and_exit</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="anypaper-anypaper-command.html#show-license-and-exit" title="show_license_and_exit ()">show_license_and_exit</a> (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span> <a class="link" href="anypaper-anypaper-command.html#anypaper-command-load" title="anypaper_command_load ()">anypaper_command_load</a> (<em class="parameter"><code><a class="link" href="anypaper-anypaper-parameters.html#AnypaperParameters"><span class="type">AnypaperParameters</span></a> *parameters</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="anypaper-anypaper-command.description"></a><h2>Description</h2>
<p>
Set of function that controls the parameters passed by the command line and the behavior of anyPaper related to them.
</p>
</div>
<div class="refsect1">
<a name="anypaper-anypaper-command.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="LICENSE:CAPS"></a><h3>LICENSE</h3>
<pre class="programlisting">#define LICENSE</pre>
<p>
macro that defines a summary of the license used
</p>
</div>
<hr>
<div class="refsect2">
<a name="show-version-and-exit"></a><h3>show_version_and_exit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> show_version_and_exit (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
shows the version of anyPaper and exits
</p>
</div>
<hr>
<div class="refsect2">
<a name="show-license-and-exit"></a><h3>show_license_and_exit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> show_license_and_exit (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
shows the version of anyPaper and the content of <a class="link" href="anypaper-anypaper-command.html#LICENSE:CAPS" title="LICENSE"><span class="type">LICENSE</span></a> and exits
</p>
</div>
<hr>
<div class="refsect2">
<a name="anypaper-command-load"></a><h3>anypaper_command_load ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> anypaper_command_load (<em class="parameter"><code><a class="link" href="anypaper-anypaper-parameters.html#AnypaperParameters"><span class="type">AnypaperParameters</span></a> *parameters</code></em>);</pre>
<p>
This function reads the parameters passed by the command line and sets the value to the right member of <a class="link" href="anypaper-anypaper-parameters.html#AnypaperParameters"><span class="type">AnypaperParameters</span></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>parameters</code></em> :</span></p></td>
<td>object that contains the parameters used in anyPaper</td>
</tr></tbody>
</table></div>
</div>
</div>
<div class="refsect1">
<a name="anypaper-anypaper-command.see-also"></a><h2>See Also</h2>
<a class="link" href="anypaper-anypaper-image.html#AnypaperImage"><span class="type">AnypaperImage</span></a>, <a class="link" href="anypaper-anypaper-parameters.html#AnypaperParameters"><span class="type">AnypaperParameters</span></a>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>