diff options
| author | Jacob McDonnell <jacob@jacobmcdonnell.com> | 2026-04-25 19:55:15 -0400 |
|---|---|---|
| committer | Jacob McDonnell <jacob@jacobmcdonnell.com> | 2026-04-25 19:55:15 -0400 |
| commit | 253e67c8b3a72b3a4757fdbc5845297628db0a4a (patch) | |
| tree | adf53b66087aa30dfbf8bf391a1dadb044c3bf4d /static/netbsd/man3/init_db.3 | |
| parent | a9157ce950dfe2fc30795d43b9d79b9d1bffc48b (diff) | |
docs: Added All NetBSD Manuals
Diffstat (limited to 'static/netbsd/man3/init_db.3')
| -rw-r--r-- | static/netbsd/man3/init_db.3 | 100 |
1 files changed, 100 insertions, 0 deletions
diff --git a/static/netbsd/man3/init_db.3 b/static/netbsd/man3/init_db.3 new file mode 100644 index 00000000..92243200 --- /dev/null +++ b/static/netbsd/man3/init_db.3 @@ -0,0 +1,100 @@ +.\" $NetBSD: init_db.3,v 1.4 2022/09/11 20:32:37 gutteridge 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 |
