.\" Man page generated from reStructuredText.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "MONGOC_INSTALLING" "3" "Feb 25, 2024" "1.26.0" "libmongoc"
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Much of this section of documentation has been rewritten and moved:
\fI\%Obtaining the MongoDB C Driver Libraries\fP
.UNINDENT
.UNINDENT
.SH SUPPORTED PLATFORMS
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Moved: \fI\%mongo\-c\-driver Platform Support\fP
.UNINDENT
.UNINDENT
.SH INSTALL LIBMONGOC WITH A PACKAGE MANAGER
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Moved: \fI\%Installing Prebuilt MongoDB C Driver Libraries\fP
.UNINDENT
.UNINDENT
.SH INSTALL LIBBSON WITH A PACKAGE MANAGER
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Moved: \fI\%Installing Prebuilt MongoDB C Driver Libraries\fP
.UNINDENT
.UNINDENT
.SH DOCKER IMAGE
.sp
You can find a Docker image in \fI\%Docker Hub\fP
along with example usage of using libmongoc to ping a MongoDB database from
within a Docker container.
.SH BUILD ENVIRONMENT
.sp
\fBNOTE:\fP
.INDENT 0.0
.INDENT 3.5
Moved: \fI\%Building the C Driver Libraries from Source\fP
.UNINDENT
.UNINDENT
.SS Uninstalling the installed components
.sp
There are two ways to uninstall the components that have been installed.  The first is to invoke the uninstall program directly.  On Linux/Unix:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ sudo /usr/local/share/mongo\-c\-driver/uninstall.sh
.EE
.UNINDENT
.UNINDENT
.sp
On Windows:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ C:\emongo\-c\-driver\eshare\emongo\-c\-driver\euninstall.bat
.EE
.UNINDENT
.UNINDENT
.sp
The second way to uninstall is from within the build directory, assuming that it is in the exact same state as when the install command was invoked:
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ sudo cmake \-\-build . \-\-target uninstall
.EE
.UNINDENT
.UNINDENT
.sp
The second approach simply invokes the uninstall program referenced in the first approach.
.SS Dealing with Build Failures
.sp
If your attempt to build the C driver fails, please see the \fI\%README\fP for instructions on requesting assistance.
.SH ADDITIONAL OPTIONS FOR INTEGRATORS
.sp
In the event that you are building the BSON library and/or the C driver to embed with other components and you wish to avoid the potential for collision with components installed from a standard build or from a distribution package manager, you can make use of the \fBBSON_OUTPUT_BASENAME\fP and \fBMONGOC_OUTPUT_BASENAME\fP options to \fBcmake\fP\&.
.INDENT 0.0
.INDENT 3.5
.sp
.EX
$ cmake \-DBSON_OUTPUT_BASENAME=custom_bson \-DMONGOC_OUTPUT_BASENAME=custom_mongoc ..
.EE
.UNINDENT
.UNINDENT
.sp
The above command would produce libraries named \fBlibcustom_bson.so\fP and \fBlibcustom_mongoc.so\fP (or with the extension appropriate for the build platform).  Those libraries could be placed in a standard system directory or in an alternate location and could be linked to by specifying something like \fB\-lcustom_mongoc \-lcustom_bson\fP on the linker command line (possibly adjusting the specific flags to those required by your linker).
.SH AUTHOR
MongoDB, Inc
.SH COPYRIGHT
2017-present, MongoDB, Inc
.\" Generated by docutils manpage writer.
.