1.\" $NetBSD: apropos-utils.3,v 1.1 2012/02/07 19:13:32 joerg Exp $ 2.\" 3.\" Copyright (c) 2011 Abhinav Upadhyay <er.abhinav.upadhyay@gmail.com> 4.\" All rights reserved. 5.\" 6.\" This code was developed as part of Google's Summer of Code 2011 program. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in 16.\" the documentation and/or other materials provided with the 17.\" distribution. 18.\" 19.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 22.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 23.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 24.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, 25.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 26.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 27.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 28.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 29.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.Dd August 17, 2011 33.Dt APROPOS-UTILS 3 34.Os 35.Sh NAME 36.Nm apropos-utils 37.Nd support functions for querying the man page index 38.Sh SYNOPSIS 39.In apropos-utils.h 40.Ft sqlite3 * 41.Fn init_db "int db_flag" 42.Ft void 43.Fn close_db "sqlite3 *db" 44.Ft int 45.Fn run_query "sqlite3 *db" "const char *snippet_args[3]" "query_args *args" 46.Ft int 47.Fn run_query_html "sqlite3 *db" "query_args *args" 48.Ft int 49.Fn run_query_pager "sqlite3 *db" "query_args *args" 50.Sh DESCRIPTION 51These functions all live in the 52.Pa apropos-utils.h 53header file. 54They operate on 55.Pa /var/db/man.db 56which is an Sqlite database containing a full text search index of the manual 57pages. 58The functions provide an easy to use interface to query the database and 59develop applications on top of it. 60.Sh SEE ALSO 61.Xr close_db 3 , 62.Xr init_db 3 , 63.Xr run_query 3 , 64.Xr run_query_html 3 , 65.Xr run_query_pager 3 66.Sh AUTHORS 67.An Abhinav Upadhyay 68