This file is indexed.

/usr/share/doc/libbobcat4-dev/man/configfile.3.html is in libbobcat-dev 4.01.03-2ubuntu1.

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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
<!DOCTYPE html><html><head>
<meta charset="UTF-8">
<title>FBB::ConfigFile</title>
<style type="text/css">
    figure {text-align: center;}
    img {vertical-align: center;}
</style>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1>FBB::ConfigFile</h1>
<h2>libbobcat-dev_4.01.03-x.tar.gz</h2>
<h2>2005-2015</h2>

<!DOCTYPE html><html><head>
<meta charset="UTF-8">
<style type="text/css">
    figure {text-align: center;}
    img {vertical-align: center;}
    figure {text-align: center;}
    img {vertical-align: center;}
</style>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1></h1>

<!DOCTYPE html><html><head>
<meta charset="UTF-8">
<title>FBB::ConfigFile(3bobcat)</title>
<style type="text/css">
    figure {text-align: center;}
    img {vertical-align: center;}
    figure {text-align: center;}
    img {vertical-align: center;}
    figure {text-align: center;}
    img {vertical-align: center;}
</style>
<link rev="made" href="mailto:Frank B. Brokken: f.b.brokken@rug.nl">
</head>
<body text="#27408B" bgcolor="#FFFAF0">
<hr>
<h1>FBB::ConfigFile(3bobcat)</h1>
<h2>libbobcat-dev_4.01.03-x.tar.gz Configuration File Processing</h2>
<h2>2005-2015</h2>


<p>
<h2>NAME</h2>FBB::ConfigFile - A class processing standard unix-like configuration files
<p>
<h2>SYNOPSIS</h2>
    <strong>#include &lt;bobcat/configfile&gt;</strong><br>
    Linking option: <em>-lbobcat</em> 
<p>
<h2>DESCRIPTION</h2>
    <strong>ConfigFile</strong> objects read standard <em>unix</em>-style configuration
files.  Lines are stored with initial white-space (blanks and tabs) removed.
If a line ends in \, then the next line (initial white-space removed) is
appended to the current line.
<p>
If the <em>rmComment</em> flag is set to <em>true</em> blanks lines and 
information on lines from the first <em>#</em> are removed. If the comment 
character (<em>#</em>) is
prefixed by a backslash (i.e., <em>\#</em>) it is not considered comment, but
replaced by a single <em>#</em> character. Likewise, if the <em>rmComment</em> flag was
set two consecutive backslash characters are replaced by a single backslash
character, In the retrieved configuration information it
appears as a single <em>#</em> character. If the configuration file should contain
<em>\#</em> write <em>\\#</em>, this results in replacing <em>\#</em> by <em>#</em>, leaving
<em>\#</em>.
<p>
All non-empty lines of the configuration file (when comment is ignored comment
is not considered to be line-content) are stored in the <strong>ConfigFile</strong> object.
When line indices should be stored the (0-based) line indices of lines are
available as well.
<p>
At construction time comment handling (keep comment / remove comment),
case-sensitive searching (sensitive / insensitive) and index storage (store /
don't store) can be specified.
<p>
It can't be modified using the <em>open</em> member, but overloaded assignment is
supported and comment and letter case handling can be modified by set-members.
<p>
<h2>NAMESPACE</h2>
    <strong>FBB</strong><br>
    All constructors, members, operators and manipulators, mentioned in this
man-page, are defined in the namespace <strong>FBB</strong>.
<p>
<h2>INHERITS FROM</h2>
    -
<p>
<h2>ENUMERATIONS</h2>
    The following enumerations are defined by the class <strong>ConfigFile</strong>:
    <ul>
    <li> <strong>Comment</strong>:<br>
        This enumeration has two values: <br>
        <strong>ConfigFile::KeepComment</strong> is used to indicate that comment on
lines must be kept; <br>
        <strong>ConfigFile::RemoveComment</strong> is used to indicate that comment on
lines must be removed;
    <li> <strong>SearchCasing</strong>:<br>
        This enumeration also has two values:<br> 
        <strong>ConfigFile::SearchCaseSensitive</strong> is used to do case sensitive
searches for targets;<br>
        <strong>ConfigFile::SearchCaseInsensitive</strong> is used to do case
insensitive searches for targets.
    <li> <strong>Indices</strong>:<br>
        This enumeration also has two values:<br> 
        <strong>ConfigFile::IgnoreIndices</strong> when used, the line numbers of the
original configuration file are not available;<br>
        <strong>ConfigFile::StoreIndices</strong> when used, the line numbers of the
original configuration file are also available;<br>
    </ul>
<p>
<h2>TYPES</h2>
    The following types are defined by the class <em>ConfigFile</em>:
    <ul>
    <li> <strong>const_iterator</strong>:<br> 
        a <em>const_iterator</em> is an iterator pointing to a
line (<em>std::string</em>) of the configuration file;
    <li> <strong>const_RE_iterator</strong>:<br> a <em>const_RE_iterator</em> is an iterator pointing to
lines matching a regular expression. It supports the following operations:
        <ul>
        <li> <em>const_RE_iterator &amp;operator++()</em>: the prefix increment operator
increments the iterator to point to the next line in the configuration file
matching the iterator's regular expression;
        <li> <em>std::string const &amp;operator*()</em>: the dereferencing operator
returns the line of the configuration file the iterator refers to;
        <li> <em>std::string const *operator-&gt;()</em>: the pointer operator returns the
address of the line of the configuration file the iterator refers to;
        </ul>
    <em>const_RE_iterator</em>s can be compared for (in)equality and they can be
copy-constructed; <em>const_RE_iterator</em> objects are returned by the
<em>ConfigFile::beginRE</em>, <em>ConfigFile::endRE</em> and <em>ConfigFile::beginEndRE</em>
members and cannot otherwise be constructed.
<p>
When two <em>const_RE_iterator</em> objects are subtracted the
number of lines matching their regular expression is returned. E.g., (see
below for a description of the functions used in the next example):
        <pre>

    ConfigFile cf(...)
    auto iters = cf.beginEndRE("^hello");
    cout &lt;&lt; "There are " &lt;&lt; (iters.second - iters.first) &lt;&lt; 
            " lines starting with hello\n";
        
</pre>

    The two <em>const_RE_iterator</em> objects should refer to the same regular
expression. The provided example illustrates how this is realized using
<em>beginEndRE</em>.
<p>
<em>FBB::Pattern</em> is used to perform the regular expression pattern
matching.
    </ul>
<p>
<h2>CONSTRUCTORS</h2>
    <ul>
    <li> <strong>ConfigFile(Comment cType = KeepComment, SearchCasing sType =
            SearchCaseSensitive, Indices iType = IgnoreIndices)</strong>:<br>
        This constructor is used to create an empty <strong>ConfigFile</strong>
object. It is not associated with an input stream: the <em>open</em> member can
be used for that. The parameters can be used to specify specific handling of
comment, letter-casing and storage of line numbers in the original
configuration file.
    <li> <strong>ConfigFile(std::string const &amp;fname, Comment cType = KeepComment,
            SearchCasing sType = SearchCaseSensitive, 
            Indices iType = IgnoreIndices)</strong>:<br>
        This constructor is used to create a <strong>ConfigFile</strong> object, which
is filled with the information from a file whose name is provided as the
constructor's first argument. The other parameters are used as described with
the first constructor. It throws an <em>FBB::Exception</em> exception if the file
could not be opened.
    </ul>
<p>
Copy and move constructors are available.
<p>
<h2>OVERLOADED OPERATORS</h2>
    <ul>
    <li> <strong>std::string const &amp;operator[](size_t idx) const</strong>:<br>
        This member returns the (0-based) <em>idx</em>-th line of the configuration
    file. 
    </ul><br>
    The overloaded assignment and move assignment operators are available.
<p>
<h2>MEMBER FUNCTIONS</h2>
    <ul>
    <li> <strong>ConfigFile::const_iterator begin() const</strong>:<br>
        This member returns a <em>const_iterator</em> to the first line of the
configuration file.
<p>
<li> <strong>ConfigFile::const_iterator end() const</strong>:<br>
        This member returns a <em>const_iterator</em> pointing beyond the last line
of the configuration file.
<p>
<li> <strong>std::pair&lt;ConfigFile::const_RE_iterator, ConfigFile::const_RE_iterator&gt;
         beginEndRE(std::string const &amp;target) const</strong>:<br>
        A pair of <em>const_RE_iterators</em> is returned. The <em>first</em>
field of the pair is a <em>const</em> iterator to the first element (i.e.,
line) of the <strong>ConfigFile</strong> object in which the regular expression <em>target</em>
is found. 
<p>
The <em>second</em> field is a <em>const</em> iterator marking the end of the
series of lines started at the the first line matching the regular expression
specified by <em>target</em>.
<p>
If the <em>RemoveComment</em> flag was specified, then comment-text is not
searched.  The iterator returned in the pair's <em>first</em> field can be
incremented until the iteratr returned in the pair's <em>second</em> field is
reached; all iterators (unequal the iterator in <em>second</em>) point to lines
matching the specified regular expression.  
<p>
The iterator's increment operator searches the next line matching the
specified regular expression.
<p>
Although the difference between two <em>const_RE_iterators</em> can be computed
it is a relatively expensive operation. The difference is obtained by
performing repeated regular expression matchings rather than the mere
algebraic subtraction of pointer values. If the difference cannot be computed
<em>std::numeric_limits&lt;size_t&gt;::max()</em> is returned.
<p>
This member also interprets the <em>SearchCasing</em> flag.
<p>
<li> <strong>std::pair&lt;ConfigFile::const_RE_iterator, ConfigFile::const_RE_iterator&gt;
         beginEndRE() const</strong>:<br>
        A pair of <em>const_RE_iterators</em> is returned, both marking the end of
a regular expression search.
<p>
<li> <strong>ConfigFile::const_iterator find(std::string const &amp;target) const</strong>:<br>
        This member returns an iterator to the first element (i.e., line) of
the <em>FBB::ConfigFile</em> object in which <em>target</em> is found. Note that
<em>target</em> may appear anywhere within a line. If the <em>RemoveComment</em> flag
was specified, then comment-text is not searched. Use the <em>end</em> member to
determine the end-iterator. It is not guaranteed that all lines between the
returned iterator and <em>end</em> contain <em>target</em>.  This member also
interprets the <em>SearchCasing</em> flag.
<p>
<li> <strong>std::string findKey(std::string const &amp;keyPattern, 
                                                     size_t count = 1) const</strong>:<br>
        This member can be used to retrieve information from lines having the
general pattern `<em>keyPattern value</em>'. Initial and trailing white space on
lines are ignored. <em>keyPattern</em> itself should not contain initial or
trailing white space. At least one white space character must appear between
<em>keyPattern</em> and <em>value</em>. If at least <em>count</em> lines were found matching
<em>keyPattern value</em> then this member returns the first sequence of non white
space characters following <em>keyPattern</em> after matching <em>count</em> lines
matching <em>keyPattern value</em> (i.e., `<em>value</em>' is returned). If <em>value</em> is
empty or if fewer than <em>count</em> lines match <em>keyPattern</em> an empty string is
returned. An <em>FBB::Exception</em> exception is thrown if <em>count</em> equals 0.
<p>
<li> <strong>std::string findKeyTail(std::string const &amp;keyPattern, 
                                                    size_t count = 1) const</strong>:<br>
        This member can be used to retrieve information from lines having the
general pattern `<em>keyPattern value</em>', merely followed by white
space. Initial and trailing white space on lines are ignored. <em>keyPattern</em>
itself should not contain initial or trailing white space. At least one white
space character must appear between <em>keyPattern</em> and <em>value</em>.  If at least
<em>count</em> lines were found matching <em>keyPattern value</em> then this member
returns the information beyond <em>keyPattern</em> after matching <em>count</em> lines
matching <em>keyPattern</em> (i.e., `<em>value</em>' is returned). This function differs
from <em>findKey</em> in that all information trailing <em>keyPattern</em> is returned
in <em>value</em>.  If <em>value</em> is empty or if fewer than <em>count</em> lines match
<em>keyPattern</em> an empty string is returned. An <em>FBB::Exception</em> exception is
thrown if <em>count</em> equals 0.
<p>
<li> <strong>ConfigFile::const_iterator findRE(std::string const &amp;target) const</strong>:<br>
        This member returns an iterator to the first line of the
<strong>ConfigFile</strong> object matching the regular expression <em>target</em>. After
calling this function <em>beginEndRE</em> returns an iterator pair whose <em>first</em>
field is an iterator to the same line and whose <em>second</em> field is the
end-iterator for lines matching <em>target</em>. If the <em>RemoveComment</em> flag was
specified, then comment-text is not searched.  The inherited <em>end</em> member
can be used to determine the end-iterator. It is not guaranteed that all lines
between the returned iterator and <em>end</em> also contain <em>target</em>. If
that is required, the members <em>beginRE</em> and <em>endRE</em> can be used.  This
member also interprets the <em>SearchCasing</em> flag.
<p>
<li> <strong>size_t index(size_t idx)</strong>:<br>
        This function should only be used when the parameter <em>StoreIndices</em>
was specified at construction time. In that case it returns the original
0-based line index in the configuration file associated with the
<em>idx</em><sup>th</sup> (0-based) index in the current <em>Configuration</em> object.
<p>
<li> <strong>size_t index(const_iterator const &amp;iter)</strong>:<br>
        This function should only be used when the parameter <em>StoreIndices</em>
was specified at construction time. In that case it returns the original
0-based line index in the configuration file associated with the configuration
line in the current <em>Configuration</em> object pointed to by <em>iter</em>. This may
also be an (incremented version of the) iterator returned by the member
<em>findRE</em> or <em>beginRE</em>, as long as the iterator's value is within the half
open range <em>beginRE</em> to <em>endRE</em>.
<p>
<li> <strong>void open(std::string const &amp;fname)</strong>:<br>
        This member reads the configuration file having name <em>fname</em>.
It redefines the current contents of the <strong>ConfigFile</strong> object,
destroying any information previously stored in it. The configuation file is
read according to the latest setting of the comment-flag. It throws an
<em>FBB::Exception</em> exception if the file cannot be opened.
<p>
This member clears previously available information and reinitializes the
object with information read from the new file.
<p>
<li> <strong>void setCommentHandling(Comment type)</strong>:<br>
        This member can be used to change the comment-handling type originally
set by the constructor, or set by earlier calls of this function. When called
it won't affect the current contents of the <strong>ConfigFile</strong> object, but
new calls of its <em>open</em> member reads the configuation file according
to the last setting of the comment flag.
<p>
<li> <strong>void setSearchCasing(SearchCasing type)</strong>:<br>
        This member can be used to change the handling of the letter-casing
originally set by the constructor, or set by earlier calls of this
function. When called it won't affect the current contents of the
<strong>ConfigFile</strong> object, but new calls of its <em>open</em> member reads the
configuation file according to the last setting of the letter-casing flag.
<p>
<li> <strong>size_t size() const</strong>:<br>
        This member returns the number of lines in the configuration file.
    </ul>
<p>
<h2>EXAMPLE</h2>
    Assume the configuration file is called <em>config.rc</em> and contains the
following lines: 
<p>

    <pre>


# this is ignored

noline: this one too

line: this is found

this is not a line containing line: at the beginning of the line

line: this one is

    line: what about this one? \ 
        it's extending over multiple lines

and there may, of course, be more lines in this file
    
</pre>

<p>
The following program may be compiled and run as <em>a.out config.rc</em>:
    <pre>

#include &lt;iostream&gt;
#include &lt;iterator&gt;
#include &lt;algorithm&gt;
#include &lt;string&gt;
#include &lt;bobcat/configfile&gt;

using namespace std;
using namespace FBB;
    
int main(int argc, char **argv)
{
    ConfigFile cf(argv[1]);     

    cout &lt;&lt; *cf.find("this one") &lt;&lt; endl; // find text within a line

                                         // find all lines matching 
                                         // `^line:'
    copy(cf.beginRE("^line:"), cf.endRE(), 
                    ostream_iterator&lt;string&gt;(cout, "\n"));
}
    
</pre>

<p>
Producing the output:
    <pre>

noline: this one too
line: this is found
line: this one is
line: what about this one? it's extending over multiple lines
    
</pre>

<p>
<h2>FILES</h2>
    <em>bobcat/configfile</em> - defines the class interface
<p>
<h2>SEE ALSO</h2>
    <strong>argconfig</strong>(3bobcat), <strong>bobcat</strong>(7), <strong>exception</strong>(3bobcat), 
    <strong>pattern</strong>(3bobcat)
<p>
<h2>BUGS</h2>
    None Reported.
<p>

<h2>DISTRIBUTION FILES</h2>
    <ul>
    <li> <em>bobcat_4.01.03-x.dsc</em>: detached signature;
    <li> <em>bobcat_4.01.03-x.tar.gz</em>: source archive;
    <li> <em>bobcat_4.01.03-x_i386.changes</em>: change log;
    <li> <em>libbobcat1_4.01.03-x_*.deb</em>: debian package holding the
            libraries;
    <li> <em>libbobcat1-dev_4.01.03-x_*.deb</em>: debian package holding the
            libraries, headers and manual pages;
    <li> <em>http://sourceforge.net/projects/bobcat</em>: public archive location;
    </ul>
<p>
<h2>BOBCAT</h2>
    Bobcat is an acronym of `Brokken's Own Base Classes And Templates'.
<p>
<h2>COPYRIGHT</h2>
    This is free software, distributed under the terms of the 
    GNU General Public License (GPL).
<p>
<h2>AUTHOR</h2>
    Frank B. Brokken (<strong>f.b.brokken@rug.nl</strong>).
<p>