\" $NetBSD: apropos-utils.3,v 1.5 2022/09/11 20:32:37 gutteridge Exp $
\"
\" Copyright (c) 2011 Abhinav Upadhyay <
[email protected]>
\" 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 23, 2016
Dt APROPOS-UTILS 3
Os
Sh NAME
Nm apropos-utils
Nd support functions for querying the man page index
Sh SYNOPSIS
In apropos-utils.h
Ft sqlite3 *
Fn init_db "mandb_access_mode db_flag" "const char * manconf"
Ft void
Fn close_db "sqlite3 *db"
Ft int
Fn run_query "sqlite3 *db" "query_format fmt" "query_args *args"
Sh DESCRIPTION
These functions all live in the
Pa apropos-utils.h
header file.
They operate on
Pa /var/db/man.db
which is an SQLite database containing a full text search index of the manual
pages.
The functions provide an easy to use interface to query the database and
develop applications on top of it.
Sh SEE ALSO
Xr close_db 3 ,
Xr init_db 3 ,
Xr run_query 3
Sh AUTHORS
An Abhinav Upadhyay
