This file is indexed.

/usr/share/gtk-doc/html/meta/meta-Main.html is in libmutter-dev 3.10.4-0ubuntu2.

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
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Mutter Reference Manual: Main</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Mutter Reference Manual">
<link rel="up" href="core-reference.html" title="Part III. Mutter Core Reference">
<link rel="prev" href="core-reference.html" title="Part III. Mutter Core Reference">
<link rel="next" href="meta-Common.html" title="Common">
<meta name="generator" content="GTK-Doc V1.19.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="10"><tr valign="middle">
<td width="100%" align="left">
<a href="#" class="shortcut">Top</a>
                   | 
                  <a href="#meta-Main.description" class="shortcut">Description</a>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="core-reference.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="core-reference.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="meta-Common.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="meta-Main"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="meta-Main.top_of_page"></a>Main</span></h2>
<p>Main — Program startup.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="meta-Main.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis"><span class="returnvalue">GOptionContext</span> *    <a class="link" href="meta-Main.html#meta-get-option-context" title="meta_get_option_context ()">meta_get_option_context</a>             (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="meta-Main.html#meta-init" title="meta_init ()">meta_init</a>                           (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">int</span>                 <a class="link" href="meta-Main.html#meta-run" title="meta_run ()">meta_run</a>                            (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="meta-Main.html#meta-get-replace-current-wm" title="meta_get_replace_current_wm ()">meta_get_replace_current_wm</a>         (<em class="parameter"><code><span class="type">void</span></code></em>);
<span class="returnvalue">void</span>                <a class="link" href="meta-Main.html#meta-set-wm-name" title="meta_set_wm_name ()">meta_set_wm_name</a>                    (<em class="parameter"><code>const <span class="type">char</span> *wm_name</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="meta-Main.html#meta-set-gnome-wm-keybindings" title="meta_set_gnome_wm_keybindings ()">meta_set_gnome_wm_keybindings</a>       (<em class="parameter"><code>const <span class="type">char</span> *wm_keybindings</code></em>);
enum                <a class="link" href="meta-Main.html#MetaExitCode" title="enum MetaExitCode">MetaExitCode</a>;
<span class="returnvalue">void</span>                <a class="link" href="meta-Main.html#meta-exit" title="meta_exit ()">meta_exit</a>                           (<em class="parameter"><code><a class="link" href="meta-Main.html#MetaExitCode" title="enum MetaExitCode"><span class="type">MetaExitCode</span></a> code</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="meta-Main.html#meta-quit" title="meta_quit ()">meta_quit</a>                           (<em class="parameter"><code><a class="link" href="meta-Main.html#MetaExitCode" title="enum MetaExitCode"><span class="type">MetaExitCode</span></a> code</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="meta-Main.description"></a><h2>Description</h2>
<p>
Functions which parse the command-line arguments, create the display,
kick everything off and then close down Mutter when it's time to go.
</p>
<p>
Mutter - a boring window manager for the adult in you
</p>
<p>
Many window managers are like Marshmallow Froot Loops; Mutter
is like Frosted Flakes: it's still plain old corn, but dusted
with some sugar.
</p>
<p>
The best way to get a handle on how the whole system fits together
is discussed in doc/code-overview.txt; if you're looking for functions
to investigate, read <code class="function">main()</code>, <code class="function">meta_display_open()</code>, and <code class="function">event_callback()</code>.
</p>
</div>
<div class="refsect1">
<a name="meta-Main.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="meta-get-option-context"></a><h3>meta_get_option_context ()</h3>
<pre class="programlisting"><span class="returnvalue">GOptionContext</span> *    meta_get_option_context             (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Returns a <span class="type">GOptionContext</span> initialized with mutter-related options.
Parse the command-line args with this before calling <a class="link" href="meta-Main.html#meta-init" title="meta_init ()"><code class="function">meta_init()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <span class="type">GOptionContext</span>
</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="meta-init"></a><h3>meta_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                meta_init                           (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Initialize mutter. Call this after <a class="link" href="meta-Main.html#meta-get-option-context" title="meta_get_option_context ()"><code class="function">meta_get_option_context()</code></a> and
<a class="link" href="MetaPlugin.html#meta-plugin-manager-set-plugin-type" title="meta_plugin_manager_set_plugin_type ()"><code class="function">meta_plugin_manager_set_plugin_type()</code></a>, and before <a class="link" href="meta-Main.html#meta-run" title="meta_run ()"><code class="function">meta_run()</code></a>.
</p>
</div>
<hr>
<div class="refsect2">
<a name="meta-run"></a><h3>meta_run ()</h3>
<pre class="programlisting"><span class="returnvalue">int</span>                 meta_run                            (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>
Runs mutter. Call this after completing initialization that doesn't require
an event loop.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>mutter's exit status</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="meta-get-replace-current-wm"></a><h3>meta_get_replace_current_wm ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            meta_get_replace_current_wm         (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="meta-set-wm-name"></a><h3>meta_set_wm_name ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                meta_set_wm_name                    (<em class="parameter"><code>const <span class="type">char</span> *wm_name</code></em>);</pre>
<p>
Set the value to use for the _NET_WM_NAME property. To take effect,
it is necessary to call this function before <a class="link" href="meta-Main.html#meta-init" title="meta_init ()"><code class="function">meta_init()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>wm_name</code></em> :</span></p></td>
<td>value for _NET_WM_NAME</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="meta-set-gnome-wm-keybindings"></a><h3>meta_set_gnome_wm_keybindings ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                meta_set_gnome_wm_keybindings       (<em class="parameter"><code>const <span class="type">char</span> *wm_keybindings</code></em>);</pre>
<p>
Set the value to use for the _GNOME_WM_KEYBINDINGS property. To take
effect, it is necessary to call this function before <a class="link" href="meta-Main.html#meta-init" title="meta_init ()"><code class="function">meta_init()</code></a>.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>wm_keybindings</code></em> :</span></p></td>
<td>value for _GNOME_WM_KEYBINDINGS</td>
</tr></tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="MetaExitCode"></a><h3>enum MetaExitCode</h3>
<pre class="programlisting">typedef enum {
  META_EXIT_SUCCESS,
  META_EXIT_ERROR
} MetaExitCode;
</pre>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><a name="META-EXIT-SUCCESS:CAPS"></a><span class="term"><code class="literal">META_EXIT_SUCCESS</code></span></p></td>
<td>Success
</td>
</tr>
<tr>
<td><p><a name="META-EXIT-ERROR:CAPS"></a><span class="term"><code class="literal">META_EXIT_ERROR</code></span></p></td>
<td>Error
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="meta-exit"></a><h3>meta_exit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                meta_exit                           (<em class="parameter"><code><a class="link" href="meta-Main.html#MetaExitCode" title="enum MetaExitCode"><span class="type">MetaExitCode</span></a> code</code></em>);</pre>
</div>
<hr>
<div class="refsect2">
<a name="meta-quit"></a><h3>meta_quit ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                meta_quit                           (<em class="parameter"><code><a class="link" href="meta-Main.html#MetaExitCode" title="enum MetaExitCode"><span class="type">MetaExitCode</span></a> code</code></em>);</pre>
<p>
Stops Mutter. This tells the event loop to stop processing; it is
rather dangerous to use this because this will leave the user with
no window manager. We generally do this only if, for example, the
session manager asks us to; we assume the session manager knows
what it's talking about.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>code</code></em> :</span></p></td>
<td>The success or failure code to return to the calling process.</td>
</tr></tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.19.1</div>
</body>
</html>