101 lines
3.2 KiB
Groff
101 lines
3.2 KiB
Groff
.\" $NetBSD: init_db.3,v 1.3 2016/05/24 18:06:42 abhinav Exp $
|
|
.\"
|
|
.\" 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 May 22, 2016
|
|
.Dt INIT_DB 3
|
|
.Os
|
|
.Sh NAME
|
|
.Nm init_db
|
|
.Nd open apropos database connection
|
|
.Sh SYNOPSIS
|
|
.In apropos-utils.h
|
|
.Ft sqlite3 *
|
|
.Fn init_db "mandb_access_mode db_flag" "const char *manconf"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn init_db
|
|
function will try to initialize a connection to
|
|
.Pa 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.
|
|
.Pp
|
|
The argument
|
|
.Fa db_flag
|
|
can be one of the following:
|
|
.Bl -hang -width -compact
|
|
.It Dv MANDB_READONLY
|
|
This will open the database in read-only mode.
|
|
Use this when you only want to query the database.
|
|
.It Dv MANDB_WRITE
|
|
This will open the database in read/write mode.
|
|
.It 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
|
|
.Pp
|
|
The second argument
|
|
.Fa manconf
|
|
specifies the location of the man.conf configuration file.
|
|
By default it is stored at
|
|
.Pa /etc/man.conf .
|
|
The location of the man.db database is configured in the configuration file
|
|
using the
|
|
.Cd _mandb
|
|
tag.
|
|
.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.
|
|
.Pp
|
|
In case the man.db file does not exist and
|
|
.Dv DB_CREATE
|
|
is not used as a value of
|
|
.Fa db_flag ,
|
|
.Dv NULL
|
|
will be returned.
|
|
.Sh FILES
|
|
.Bl -hang -width /etc/man.conf -compact
|
|
.It Pa /etc/man.conf
|
|
The location of the Sqlite FTS database can be configured using the
|
|
.Cd _mandb
|
|
tag.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr apropos-utils 3 ,
|
|
.Xr close_db 3 ,
|
|
.Xr run_query 3
|
|
.Sh AUTHORS
|
|
.An Abhinav Upadhyay
|