This file is indexed.

/usr/share/gtk-doc/html/libgtop/libgtop-GlibTop.html is in libgtop2-doc 2.28.4-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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GlibTop</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="Libgtop Reference Manual">
<link rel="up" href="libgtop-lib.html" title="Libgtop Library Reference">
<link rel="prev" href="libgtop-lib.html" title="Libgtop Library Reference">
<link rel="next" href="libgtop-Close.html" title="Close">
<meta name="generator" content="GTK-Doc V1.17.1 (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="libgtop-lib.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="libgtop-lib.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">Libgtop Reference Manual</th>
<td><a accesskey="n" href="libgtop-Close.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libgtop-GlibTop.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libgtop-GlibTop.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libgtop-GlibTop"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libgtop-GlibTop.top_of_page"></a>GlibTop</span></h2>
<p>GlibTop — Server initilization</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libgtop-GlibTop.stability-level"></a><h2>Stability Level</h2>
Stable, unless otherwise indicated
</div>
<div class="refsynopsisdiv">
<a name="libgtop-GlibTop.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include &lt;glibtop.h&gt;

#define             <a class="link" href="libgtop-GlibTop.html#GLIBTOP-MOUNTENTRY-LEN:CAPS" title="GLIBTOP_MOUNTENTRY_LEN">GLIBTOP_MOUNTENTRY_LEN</a>
#define             <a class="link" href="libgtop-GlibTop.html#LIBGTOP-CHECK-VERSION:CAPS" title="LIBGTOP_CHECK_VERSION()">LIBGTOP_CHECK_VERSION</a>               (major,
                                                         minor,
                                                         micro)
struct              <a class="link" href="libgtop-GlibTop.html#glibtop" title="struct glibtop">glibtop</a>;
extern glibtop *    <a class="link" href="libgtop-GlibTop.html#glibtop-global-server" title="glibtop_global_server">glibtop_global_server</a>;
<a class="link" href="libgtop-GlibTop.html#glibtop" title="struct glibtop"><span class="returnvalue">glibtop</span></a> *           <a class="link" href="libgtop-GlibTop.html#glibtop-init" title="glibtop_init ()">glibtop_init</a>                        (<em class="parameter"><code><span class="type">void</span></code></em>);
<a class="link" href="libgtop-GlibTop.html#glibtop" title="struct glibtop"><span class="returnvalue">glibtop</span></a> *           <a class="link" href="libgtop-GlibTop.html#glibtop-init-r" title="glibtop_init_r ()">glibtop_init_r</a>                      (<em class="parameter"><code><a class="link" href="libgtop-GlibTop.html#glibtop" title="struct glibtop"><span class="type">glibtop</span></a> **server_ptr</code></em>,
                                                         <em class="parameter"><code><span class="type">unsigned long </span> features</code></em>,
                                                         <em class="parameter"><code><span class="type">unsigned </span> flags</code></em>);
<a class="link" href="libgtop-GlibTop.html#glibtop" title="struct glibtop"><span class="returnvalue">glibtop</span></a> *           <a class="link" href="libgtop-GlibTop.html#glibtop-init-s" title="glibtop_init_s ()">glibtop_init_s</a>                      (<em class="parameter"><code><a class="link" href="libgtop-GlibTop.html#glibtop" title="struct glibtop"><span class="type">glibtop</span></a> **server_ptr</code></em>,
                                                         <em class="parameter"><code><span class="type">unsigned long </span> features</code></em>,
                                                         <em class="parameter"><code><span class="type">unsigned </span> flags</code></em>);
extern const unsigned long <a class="link" href="libgtop-GlibTop.html#glibtop-server-features" title="glibtop_server_features">glibtop_server_features</a>;
</pre>
</div>
<div class="refsect1">
<a name="libgtop-GlibTop.description"></a><h2>Description</h2>
<p>
You do not need to worry about the <a class="link" href="libgtop-GlibTop.html#glibtop" title="struct glibtop"><span class="type">glibtop</span></a> * server structure if
you don't need - the library exports a <a class="link" href="libgtop-GlibTop.html#glibtop-global-server" title="glibtop_global_server"><span class="type">glibtop_global_server</span></a>
which you can use everywhere a <a class="link" href="libgtop-GlibTop.html#glibtop" title="struct glibtop"><span class="type">glibtop</span></a> * is expected.
</p>
<p>
Most of the library and all of the sysdeps function also have an alias
(which is the function name without the <span style="color: red">&lt;suffix&gt;_l&lt;/suffix&gt;</span>, 
<span style="color: red">&lt;suffix&gt;_s&lt;/suffix&gt;</span> or <span style="color: red">&lt;suffix&gt;_r&lt;/suffix&gt;</span> suffix) which don't 
take a <a class="link" href="libgtop-GlibTop.html#glibtop" title="struct glibtop"><span class="type">glibtop</span></a> * as argument but uses the <a class="link" href="libgtop-GlibTop.html#glibtop-global-server" title="glibtop_global_server"><span class="type">glibtop_global_server</span></a> 
instead.
</p>
</div>
<div class="refsect1">
<a name="libgtop-GlibTop.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GLIBTOP-MOUNTENTRY-LEN:CAPS"></a><h3>GLIBTOP_MOUNTENTRY_LEN</h3>
<pre class="programlisting">#define GLIBTOP_MOUNTENTRY_LEN 79
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="LIBGTOP-CHECK-VERSION:CAPS"></a><h3>LIBGTOP_CHECK_VERSION()</h3>
<pre class="programlisting">#define             LIBGTOP_CHECK_VERSION(major, minor, micro)</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="glibtop"></a><h3>struct glibtop</h3>
<pre class="programlisting">struct glibtop {
	unsigned flags;
	unsigned method;		/* Server Method */
	unsigned error_method;		/* Error Method */
	glibtop_machine machine; /* Machine dependent data */
	int input [2];			/* Pipe client &lt;- server */
	int output [2];			/* Pipe client -&gt; server */
	int socket;			/* Accepted connection of a socket */
	int ncpu;			/* Number of CPUs, zero if single-processor */
	int real_ncpu;			/* Real number of CPUs. Only ncpu are monitored */
	unsigned long os_version_code; /* Version code of the operating system */
	const char *name;		/* Program name for error messages */
	const char *server_command; /* Command used to invoke server */
	const char *server_host; /* Host the server should run on */
	const char *server_user; /* Name of the user on the target host */
	const char *server_rsh;		/* Command used to connect to the target host */
	unsigned long features;		/* Server is required for this features */
	unsigned long server_port; /* Port on which daemon is listening */
	glibtop_sysdeps sysdeps; /* Detailed feature list */
	glibtop_sysdeps required; /* Required feature list */
	pid_t pid;			/* PID of the server */
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="glibtop-global-server"></a><h3>glibtop_global_server</h3>
<pre class="programlisting">extern glibtop *glibtop_global_server;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="glibtop-init"></a><h3>glibtop_init ()</h3>
<pre class="programlisting"><a class="link" href="libgtop-GlibTop.html#glibtop" title="struct glibtop"><span class="returnvalue">glibtop</span></a> *           glibtop_init                        (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Server initialization.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A <a class="link" href="libgtop-GlibTop.html#glibtop" title="struct glibtop"><span class="type">glibtop</span></a> reference.</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="glibtop-init-r"></a><h3>glibtop_init_r ()</h3>
<pre class="programlisting"><a class="link" href="libgtop-GlibTop.html#glibtop" title="struct glibtop"><span class="returnvalue">glibtop</span></a> *           glibtop_init_r                      (<em class="parameter"><code><a class="link" href="libgtop-GlibTop.html#glibtop" title="struct glibtop"><span class="type">glibtop</span></a> **server_ptr</code></em>,
                                                         <em class="parameter"><code><span class="type">unsigned long </span> features</code></em>,
                                                         <em class="parameter"><code><span class="type">unsigned </span> flags</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="glibtop-init-s"></a><h3>glibtop_init_s ()</h3>
<pre class="programlisting"><a class="link" href="libgtop-GlibTop.html#glibtop" title="struct glibtop"><span class="returnvalue">glibtop</span></a> *           glibtop_init_s                      (<em class="parameter"><code><a class="link" href="libgtop-GlibTop.html#glibtop" title="struct glibtop"><span class="type">glibtop</span></a> **server_ptr</code></em>,
                                                         <em class="parameter"><code><span class="type">unsigned long </span> features</code></em>,
                                                         <em class="parameter"><code><span class="type">unsigned </span> flags</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="glibtop-server-features"></a><h3>glibtop_server_features</h3>
<pre class="programlisting">extern const unsigned long glibtop_server_features;
</pre>
<p>
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.17.1</div>
</body>
</html>