<!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/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3.1"/>
<title>libssh: The SSH logging functions.</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libssh
 <span id="projectnumber">0.5.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">The SSH logging functions.<div class="ingroups"><a class="el" href="group__libssh.html">The libssh API</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>Logging functions for debugging and problem resolving.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga06fc87d81c62e9abb8790b6e5713c55b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom">{ <br/>
  <a class="el" href="group__libssh__log.html#gga06fc87d81c62e9abb8790b6e5713c55ba95c5ce872b66ec03f3336970c1e0a774">SSH_LOG_NOLOG</a> =0,
<a class="el" href="group__libssh__log.html#gga06fc87d81c62e9abb8790b6e5713c55ba1d3fcdd7b5218f2dcc6471c436792075">SSH_LOG_RARE</a>,
<a class="el" href="group__libssh__log.html#gga06fc87d81c62e9abb8790b6e5713c55ba75fa79e63947b66462db977d9b5ae27c">SSH_LOG_PROTOCOL</a>,
<a class="el" href="group__libssh__log.html#gga06fc87d81c62e9abb8790b6e5713c55ba6445dfe21592d69d9741d319538b6673">SSH_LOG_PACKET</a>,
<br/>
  <a class="el" href="group__libssh__log.html#gga06fc87d81c62e9abb8790b6e5713c55ba926c933f61d1afa64003c1cc66f6a01c">SSH_LOG_FUNCTIONS</a>
<br/>
}</td></tr>
<tr class="memdesc:ga06fc87d81c62e9abb8790b6e5713c55b"><td class="mdescLeft"> </td><td class="mdescRight">Verbosity level for logging and help to debugging. <a href="group__libssh__log.html#ga06fc87d81c62e9abb8790b6e5713c55b">More...</a><br/></td></tr>
<tr class="separator:ga06fc87d81c62e9abb8790b6e5713c55b"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga0bb252b81e0c497fc559c9e4007cf6c5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__libssh__log.html#ga0bb252b81e0c497fc559c9e4007cf6c5">ssh_log</a> (ssh_session session, int verbosity, const char *format,...)</td></tr>
<tr class="memdesc:ga0bb252b81e0c497fc559c9e4007cf6c5"><td class="mdescLeft"> </td><td class="mdescRight">Log a SSH event. <a href="#ga0bb252b81e0c497fc559c9e4007cf6c5">More...</a><br/></td></tr>
<tr class="separator:ga0bb252b81e0c497fc559c9e4007cf6c5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Logging functions for debugging and problem resolving. </p>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga06fc87d81c62e9abb8790b6e5713c55b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div><div class="memdoc">
<p>Verbosity level for logging and help to debugging. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><em><a class="anchor" id="gga06fc87d81c62e9abb8790b6e5713c55ba95c5ce872b66ec03f3336970c1e0a774"></a>SSH_LOG_NOLOG</em> </td><td class="fielddoc">
<p>No logging at all. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga06fc87d81c62e9abb8790b6e5713c55ba1d3fcdd7b5218f2dcc6471c436792075"></a>SSH_LOG_RARE</em> </td><td class="fielddoc">
<p>Only rare and noteworthy events. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga06fc87d81c62e9abb8790b6e5713c55ba75fa79e63947b66462db977d9b5ae27c"></a>SSH_LOG_PROTOCOL</em> </td><td class="fielddoc">
<p>High level protocol information. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga06fc87d81c62e9abb8790b6e5713c55ba6445dfe21592d69d9741d319538b6673"></a>SSH_LOG_PACKET</em> </td><td class="fielddoc">
<p>Lower level protocol infomations, packet level. </p>
</td></tr>
<tr><td class="fieldname"><em><a class="anchor" id="gga06fc87d81c62e9abb8790b6e5713c55ba926c933f61d1afa64003c1cc66f6a01c"></a>SSH_LOG_FUNCTIONS</em> </td><td class="fielddoc">
<p>Every function path. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga0bb252b81e0c497fc559c9e4007cf6c5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ssh_log </td>
<td>(</td>
<td class="paramtype">ssh_session </td>
<td class="paramname"><em>session</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>verbosity</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"><em>...</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Log a SSH event. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">session</td><td>The SSH session.</td></tr>
<tr><td class="paramname">verbosity</td><td>The verbosity of the event.</td></tr>
<tr><td class="paramname">format</td><td>The format string of the log entry. </td></tr>
</table>
</dd>
</dl>
<p>Referenced by <a class="el" href="group__libssh__auth.html#ga9c8517fd342dd68a94045b1e00e15a9d">privatekey_from_file()</a>, <a class="el" href="group__libssh__channel.html#ga238f07e0455456a5bfd8a49ead917732">ssh_channel_close()</a>, <a class="el" href="group__libssh__channel.html#gac92381c4c5d4a7eab35f6e84686f033d">ssh_channel_read()</a>, <a class="el" href="group__libssh__channel.html#ga072f82fdf3e50514f747653af2c99004">ssh_channel_send_eof()</a>, <a class="el" href="group__libssh__session.html#ga032e07cbd8bc3f14cb2dd375db0b03d7">ssh_connect()</a>, <a class="el" href="group__libssh__server.html#gab60c37350653eb3b65a99ac089c55830">ssh_handle_key_exchange()</a>, <a class="el" href="group__libssh__auth.html#ga21dbd716d13837aa8c70cb3603977606">ssh_publickey_to_file()</a>, <a class="el" href="group__libssh__scp.html#gaba59cd8cc77d219cac93f865445c6e47">ssh_scp_pull_request()</a>, <a class="el" href="group__libssh__scp.html#ga544f4b9c525071910110ada94148adc6">ssh_scp_push_file()</a>, <a class="el" href="group__libssh__auth.html#gabe2888b00515e95f2e1dc50269f62027">ssh_try_publickey_from_file()</a>, <a class="el" href="group__libssh__auth.html#gad07655f2c742ce68271422197cf2acda">ssh_userauth_autopubkey()</a>, and <a class="el" href="group__libssh__auth.html#ga60e80b5020e6182da7790c1f0cb220c1">ssh_userauth_privatekey_file()</a>.</p>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
