/usr/share/doc/python-profitbricks-client-doc/html/man.html is in python-profitbricks-client-doc 1.0.0-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 | <!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>profitbricks-client — ProfitBricks Client 1.0.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '1.0.0',
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="ProfitBricks Client 1.0.0 documentation" href="index.html" />
<link rel="next" title="profitbricks_client" href="profitbricks_client.html" />
<link rel="prev" title="ProfitBricks Client documentation" href="index.html" />
</head>
<body>
<div class="related">
<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="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="profitbricks_client.html" title="profitbricks_client"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="index.html" title="ProfitBricks Client documentation"
accesskey="P">previous</a> |</li>
<li><a href="index.html">ProfitBricks Client 1.0.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="profitbricks-client">
<h1>profitbricks-client<a class="headerlink" href="#profitbricks-client" title="Permalink to this headline">¶</a></h1>
<div class="section" id="synopsis">
<h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2>
<p><tt class="docutils literal"><span class="pre">profitbricks-client</span></tt> [<em>OPTIONS</em>] <strong>–help</strong> [<em>call</em>]</p>
<p><tt class="docutils literal"><span class="pre">profitbricks-client</span></tt> [<em>OPTIONS</em>] <strong>–list</strong> [<em>keyword</em>]</p>
<p><tt class="docutils literal"><span class="pre">profitbricks-client</span></tt> [<em>OPTIONS</em>] <em>call</em> [<em>per-call-arguments</em>]</p>
</div>
<div class="section" id="description">
<h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2>
<p>The ProfitBricks client can be used to manage your data centers through ProfitBricks’ public API.</p>
</div>
<div class="section" id="options">
<h2>OPTIONS<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2>
<dl class="docutils">
<dt>-h [<em>call</em>], –help [<em>call</em>]</dt>
<dd>Display a list of options if no <em>call</em> is specified. Optional <em>call</em> displays
detailed usage information for the given call.</dd>
<dt>-l [<em>keyword</em>], –list [<em>keyword</em>]</dt>
<dd>List all available calls. Optional <em>keyword</em> refines the list to display only calls listed
under the keyword header. Available keywords are: DataCenter, Firewall, Image, InternetAccess,
LoadBalancer, Nic, Notifications, PublicIp, RomDrive, Server, Snapshot, and Storage.</dd>
<dt>call</dt>
<dd>Execute call. Additional parameters required, depending on choice of call. Use <tt class="docutils literal"><span class="pre">--list</span></tt> to
get an overview of available calls.</dd>
</dl>
<table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group" colspan="2">
<kbd><span class="option">--username <var>username</var></span></kbd></td>
</tr>
<tr><td> </td><td>username used for making the API call. The username stored in the configuration file is used if
no username is specified on the command line. If no username is stored in the configuration
file, the user will get prompted to enter their username.</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">--password <var>password</var></span></kbd></td>
</tr>
<tr><td> </td><td>plain text password used for making the API call. When no password or password file is
specified on the command line, the password stored in the configuration file will be used or
the users keyring will be queried (if the Python keyring module is installed). If no password
is found, the user will get prompted to enter their password.</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">--password-file <var>password-filename</var></span></kbd></td>
</tr>
<tr><td> </td><td>file containing the plain text password. The file must contain only one line with the password
to use. See <tt class="docutils literal"><span class="pre">--password</span></tt> for details.</td></tr>
<tr><td class="option-group" colspan="2">
<kbd><span class="option">--clear-credentials</span></kbd></td>
</tr>
<tr><td> </td><td>Clear all stored user credentials from the configuration file and the keyring.</td></tr>
</tbody>
</table>
<dl class="docutils">
<dt>–api-version [<em>version</em>]</dt>
<dd>Configure which version of the API is used for making the calls. If <em>version</em> is left
unspecified, the CLI will update to the most recent compatible release of the API.</dd>
</dl>
<table class="docutils option-list" frame="void" rules="none">
<col class="option" />
<col class="description" />
<tbody valign="top">
<tr><td class="option-group">
<kbd><span class="option">--endpoint <var>URL</var></span></kbd></td>
<td>Point the CLI at a URL of the user’s choice.</td></tr>
<tr><td class="option-group">
<kbd><span class="option">--clear-cache</span></kbd></td>
<td>Updates to the latest version of the ProfitBricks WSDL.</td></tr>
<tr><td class="option-group">
<kbd><span class="option">-v</span>, <span class="option">--verbose</span></kbd></td>
<td>Print data on the outgoing call to stderr. By default, print only response data (on stdout).</td></tr>
<tr><td class="option-group">
<kbd><span class="option">--xml</span></kbd></td>
<td>Returns an XML formatted version of the response.</td></tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">profitbricks-client</a><ul>
<li><a class="reference internal" href="#synopsis">SYNOPSIS</a></li>
<li><a class="reference internal" href="#description">DESCRIPTION</a></li>
<li><a class="reference internal" href="#options">OPTIONS</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="index.html"
title="previous chapter">ProfitBricks Client documentation</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="profitbricks_client.html"
title="next chapter">profitbricks_client</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/man.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<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">
<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="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="profitbricks_client.html" title="profitbricks_client"
>next</a> |</li>
<li class="right" >
<a href="index.html" title="ProfitBricks Client documentation"
>previous</a> |</li>
<li><a href="index.html">ProfitBricks Client 1.0.0 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2014, ProfitBricks GmbH.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
</div>
</body>
</html>
|