xref: /netbsd-src/usr.sbin/makemandb/close_db.3 (revision c38e7cc395b1472a774ff828e46123de44c628e9)
1.\" $NetBSD: close_db.3,v 1.2 2016/05/24 18:06:42 abhinav 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 May 23, 2016
33.Dt CLOSE_DB 3
34.Os
35.Sh NAME
36.Nm close_db
37.Nd close apropos database connection
38.Sh SYNOPSIS
39.In apropos-utils.h
40.Ft void
41.Fn close_db "sqlite3 *db"
42.Sh DESCRIPTION
43The
44.Fn close_db
45function will close the connection to
46.Pa /var/db/man.db
47referenced by
48.Fa db
49and release any resources being used by it safely.
50.Sh FILES
51.Bl -hang -width /var/db/man.db -compact
52.It Pa /var/db/man.db
53The Sqlite FTS database which contains an index of the manual pages.
54.El
55.Sh SEE ALSO
56.Xr apropos-utils 3 ,
57.Xr init_db 3 ,
58.Xr run_query 3
59.Sh AUTHORS
60.An Abhinav Upadhyay
61