This file is indexed.

/usr/share/gtk-doc/html/gnet/gnet-socks.html is in libgnet-dev 2.0.8-2.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
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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>SOCKS</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.72.0">
<link rel="start" href="index.html" title="GNet Network Library Reference Manual">
<link rel="up" href="libgnet-reference.html" title="GNet Library Reference">
<link rel="prev" href="gnet-ipv6.html" title="IPv6">
<meta name="generator" content="GTK-Doc V1.8 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="gnet-overview.html" title="GNet Overview">
<link rel="chapter" href="gnet-developers.html" title="GNet for developers">
<link rel="chapter" href="gnet-examples.html" title="GNet Examples">
<link rel="chapter" href="libgnet-reference.html" title="GNet Library Reference">
</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="gnet-ipv6.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgnet-reference.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">GNet Network Library Reference Manual</th>
<td>&#160;</td>
</tr>
<tr><td colspan="5" class="shortcuts"><nobr><a href="#id402120" class="shortcut">Top</a>
                  &#160;|&#160;
                  <a href="#id402600" class="shortcut">Description</a></nobr></td></tr>
</table>
<div class="refentry" lang="en">
<a name="gnet-socks"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2>
<a name="id402120"></a><span class="refentrytitle">SOCKS</span>
</h2>
<p>SOCKS &#8212; SOCKS proxy</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">

#include &lt;gnet.h&gt;


#define             <a href="gnet-socks.html#GNET-SOCKS-PORT:CAPS">GNET_SOCKS_PORT</a>
#define             <a href="gnet-socks.html#GNET-SOCKS-VERSION:CAPS">GNET_SOCKS_VERSION</a>
gboolean            <a href="gnet-socks.html#gnet-socks-get-enabled">gnet_socks_get_enabled</a>              (void);
void                <a href="gnet-socks.html#gnet-socks-set-enabled">gnet_socks_set_enabled</a>              (gboolean enabled);
<a href="gnet-inetaddr.html#GInetAddr">GInetAddr</a>*          <a href="gnet-socks.html#gnet-socks-get-server">gnet_socks_get_server</a>               (void);
void                <a href="gnet-socks.html#gnet-socks-set-server">gnet_socks_set_server</a>               (const <a href="gnet-inetaddr.html#GInetAddr">GInetAddr</a> *inetaddr);
gint                <a href="gnet-socks.html#gnet-socks-get-version">gnet_socks_get_version</a>              (void);
void                <a href="gnet-socks.html#gnet-socks-set-version">gnet_socks_set_version</a>              (gint version);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id402600"></a><h2>Description</h2>
<p>
SOCKS is a TCP proxy protocol.  Typically, a host behind a firewall
uses SOCKS to connect to hosts outside the firewall via a SOCKS proxy
server.  To open a TCP connection, a SOCKS client connects to a SOCKS
server and the SOCKS server connects to the destination.  Data is then
forwarded between the client and the destination by the SOCKS server.
GNet supports SOCKS versions 4 and 5.  Version 5 includes support for
server sockets.
</p>
<p>
SOCKS is used if the SOCKS_SERVER environment variable is set or
<a href="gnet-socks.html#gnet-socks-set-server"><code class="function">gnet_socks_set_server()</code></a> is called to set the SOCKS server's address.
To disable SOCKS support, call <a href="gnet-socks.html#gnet-socks-set-enabled"><code class="function">gnet_socks_set_enabled()</code></a> and pass
FALSE.  The SOCKS_VERSION environment variable controls which SOCKS
version is used.  The default is version 5.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id402645"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id402655"></a><h3>
<a name="GNET-SOCKS-PORT:CAPS"></a>GNET_SOCKS_PORT</h3>
<a class="indexterm" name="id402667"></a><pre class="programlisting">#define GNET_SOCKS_PORT 1080
</pre>
<p>
Default port for the SOCKS protocol.</p>
<p>

</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id402686"></a><h3>
<a name="GNET-SOCKS-VERSION:CAPS"></a>GNET_SOCKS_VERSION</h3>
<a class="indexterm" name="id402698"></a><pre class="programlisting">#define GNET_SOCKS_VERSION 5
</pre>
<p>
Default version of the SOCKS protocol.</p>
<p>

</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id402716"></a><h3>
<a name="gnet-socks-get-enabled"></a>gnet_socks_get_enabled ()</h3>
<a class="indexterm" name="id402729"></a><pre class="programlisting">gboolean            gnet_socks_get_enabled              (void);</pre>
<p>
Determines whether SOCKS support is enabled.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> TRUE if SOCKS is enabled, FALSE otherwise.

</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id402768"></a><h3>
<a name="gnet-socks-set-enabled"></a>gnet_socks_set_enabled ()</h3>
<a class="indexterm" name="id402781"></a><pre class="programlisting">void                gnet_socks_set_enabled              (gboolean enabled);</pre>
<p>
Sets whether SOCKS support is enabled.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>enabled</code></em>&#160;:</span></td>
<td> is SOCKS support enabled?
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id402830"></a><h3>
<a name="gnet-socks-get-server"></a>gnet_socks_get_server ()</h3>
<a class="indexterm" name="id402843"></a><pre class="programlisting"><a href="gnet-inetaddr.html#GInetAddr">GInetAddr</a>*          gnet_socks_get_server               (void);</pre>
<p>
Gets the address of the SOCKS server (regardless of whether SOCKS
 is enabled).  This function checks the <a href="gnet-socks.html#gnet-socks-set-server"><code class="function">gnet_socks_set_server()</code></a>
 value and, if not set, the SOCKS_SERVER environment variable.  The
 SOCKS_SERVER enviroment variable should be in the form HOSTNAME or
 HOSTNAME:PORT.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> a copy of the address; NULL if there is no server.

</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id402894"></a><h3>
<a name="gnet-socks-set-server"></a>gnet_socks_set_server ()</h3>
<a class="indexterm" name="id402907"></a><pre class="programlisting">void                gnet_socks_set_server               (const <a href="gnet-inetaddr.html#GInetAddr">GInetAddr</a> *inetaddr);</pre>
<p>
Sets the address of the SOCKS server.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>inetaddr</code></em>&#160;:</span></td>
<td> SOCKS server address
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id402956"></a><h3>
<a name="gnet-socks-get-version"></a>gnet_socks_get_version ()</h3>
<a class="indexterm" name="id402969"></a><pre class="programlisting">gint                gnet_socks_get_version              (void);</pre>
<p>
Gets the SOCKS version GNet uses.  This function checks the
 <a href="gnet-socks.html#gnet-socks-set-version"><code class="function">gnet_socks_set_version()</code></a> value and, if not set, the SOCKS_VERSION
 environment variable.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><span class="emphasis"><em>Returns</em></span>&#160;:</span></td>
<td> the SOCKS version.

</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id403019"></a><h3>
<a name="gnet-socks-set-version"></a>gnet_socks_set_version ()</h3>
<a class="indexterm" name="id403032"></a><pre class="programlisting">void                gnet_socks_set_version              (gint version);</pre>
<p>
Sets the SOCKS version GNet uses.  GNet only supports versions 4
 and 5.</p>
<p>

</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><span class="term"><em class="parameter"><code>version</code></em>&#160;:</span></td>
<td> SOCKS version
</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
</body>
</html>