Copyright (c) 2011 Abhinav Upadhyay <er.abhinav.upadhyay@gmail.com>
All rights reserved.
This code was developed as part of Google's Summer of Code 2011 program.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in
the documentation and/or other materials provided with the
distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
.Dd August 17, 2011 .Dt INIT_DB 3 .Os .Sh NAME .Nm init_db .Nd open apropos database connection .Sh SYNOPSIS n apropos-utils.h .Ft sqlite3 * .Fn init_db "int db_flag" .Sh DESCRIPTION The .Fn init_db function will try to initialize a connection to
a man.db which is an Sqlite database and return a pointer to a sqlite3 structure. The connection should subsequentially be closed by calling .Fn close_db which will also release any resources being used by it.
p The argument .Fa db_flag can be one of the following: l -hang -width -compact t Dv MANDB_READONLY This will open the database in read-only mode. Use this when you only want to query the database. t Dv MANDB_WRITE This will open the database in read/write mode. t Dv MANDB_CREATE This will open the database in read/write mode, and will also create the database schema if it does not exist already. .El .Sh RETURN VALUES On successful execution the .Fn init_db function will return a pointer to a sqlite3 structure which represents a connection to the database.
p In case the file
a /var/db/man.db does not exist and .Dv DB_CREATE is not used as a value of .Fa db_flag , .Dv NULL will be returned. .Sh FILES l -hang -width /var/db/man.db -compact t Pa /var/db/man.db The Sqlite FTS database which contains an index of the manual pages. .El .Sh SEE ALSO .Xr apropos-utils 3 , .Xr close_db 3 , .Xr run_query 3 , .Xr run_query_html 3 , .Xr run_query_pager 3 .Sh AUTHORS .An Abhinav Upadhyay