https://pcapplusplus.github.io/assets/js/e46b8ab2.557d31b0.js

1"use strict";(globalThis.webpackChunkpcapplusplus_github_io=globalThis.webpackChunkpcapplusplus_github_io||[]).push([[4589],{1001(e,l,s){s.r(l),s.d(l,{assets:()=>c,contentTitle:()=>r,default:()=>h,frontMatter:()=>d,metadata:()=>i,toc:()=>o});const i=JSON.parse('{"id":"install/freebsd","title":"Build on FreeBSD","description":"Prerequisites","source":"@site/versioned_docs/version-v26.07/install/freebsd.mdx","sourceDirName":"install","slug":"/install/freebsd","permalink":"/docs/install/freebsd","draft":false,"unlisted":false,"editUrl":"https://github.com/PcapPlusPlus/pcapplusplus.github.io/edit/master/versioned_docs/version-v26.07/install/freebsd.mdx","tags":[],"version":"v26.07","frontMatter":{"title":"Build on FreeBSD"},"sidebar":"docs","previous":{"title":"Build for Android","permalink":"/docs/install/android"},"next":{"title":"Feature Overview","permalink":"/docs/features"}}');var n=s(4848),t=s(8453);const d={title:"Build on FreeBSD"},r="Build From Source on FreeBSD",c={},o=[{value:"Prerequisites",id:"prerequisites",level:2},{value:"Build",id:"build",level:2},{value:"Installation",id:"installation",level:2},{value:"Running tests",id:"running-tests",level:2}];function a(e){const l={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",li:"li",ol:"ol",p:"p",pre:"pre",strong:"strong",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",ul:"ul",...(0,t.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(l.header,{children:(0,n.jsx)(l.h1,{id:"build-from-source-on-freebsd",children:"Build From Source on FreeBSD"})}),"\n",(0,n.jsx)(l.h2,{id:"prerequisites",children:"Prerequisites"}),"\n",(0,n.jsx)(l.p,{children:"In order to compile PcapPlusPlus on FreeBSD please make sure you have the following components installed:"}),"\n",(0,n.jsxs)(l.ol,{children:["\n",(0,n.jsxs)(l.li,{children:[(0,n.jsx)(l.code,{children:"git"})," (if not installed please run: ",(0,n.jsx)(l.code,{children:"pkg install git"}),")"]}),"\n",(0,n.jsxs)(l.li,{children:[(0,n.jsx)(l.code,{children:"CMake"})," (if not installed please run: ",(0,n.jsx)(l.code,{children:"pkg install cmake"}),")"]}),"\n",(0,n.jsxs)(l.li,{children:[(0,n.jsx)(l.strong,{children:"Optional"})," ",(0,n.jsx)(l.code,{children:"libpcap"})," if you want to use libpcap features such as packet capture and have ",(0,n.jsx)(l.code,{children:"-DPCAPPP_USE_PCAP=ON"})," (if not installed please run: ",(0,n.jsx)(l.code,{children:"pkg install libpcap"}),")"]}),"\n"]}),"\n",(0,n.jsx)(l.h2,{id:"build",children:"Build"}),"\n",(0,n.jsxs)(l.p,{children:["Assuming you want to build PcapPlusPlus into a ",(0,n.jsx)(l.code,{children:"build"})," directory:"]}),"\n",(0,n.jsx)(l.pre,{children:(0,n.jsx)(l.code,{className:"language-shell",children:"cmake -S . -B build\n"})}),"\n",(0,n.jsx)(l.p,{children:"And then initiate the build in one of two ways:"}),"\n",(0,n.jsxs)(l.ul,{children:["\n",(0,n.jsxs)(l.li,{children:["Using CMake:","\n",(0,n.jsx)(l.pre,{children:(0,n.jsx)(l.code,{className:"language-shell",children:"cmake --build build\n"})}),"\n"]}),"\n",(0,n.jsxs)(l.li,{children:["Using ",(0,n.jsx)(l.code,{children:"make"}),":","\n",(0,n.jsx)(l.pre,{children:(0,n.jsx)(l.code,{className:"language-shell",children:"cd build\nmake\n"})}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(l.p,{children:"This process will build the following artifacts:"}),"\n",(0,n.jsxs)(l.ul,{children:["\n",(0,n.jsxs)(l.li,{children:["PcapPlusPlus libs:","\n",(0,n.jsxs)(l.ul,{children:["\n",(0,n.jsx)(l.li,{children:(0,n.jsx)(l.code,{children:"build/Common++/libCommon++.a"})}),"\n",(0,n.jsx)(l.li,{children:(0,n.jsx)(l.code,{children:"build/Packet++/libPacket++.a"})}),"\n",(0,n.jsx)(l.li,{children:(0,n.jsx)(l.code,{children:"build/Pcap++/libPcap++.a"})}),"\n"]}),"\n"]}),"\n",(0,n.jsxs)(l.li,{children:["PcapPlusPlus examples binaries under ",(0,n.jsx)(l.code,{children:"build/examples_bin"})]}),"\n",(0,n.jsxs)(l.li,{children:["PcapPlusPlus tests:","\n",(0,n.jsxs)(l.ul,{children:["\n",(0,n.jsx)(l.li,{children:(0,n.jsx)(l.code,{children:"<PcapPlusPlus_Dir>/Tests/Packet++Test/Bin/Packet++Test"})}),"\n",(0,n.jsx)(l.li,{children:(0,n.jsx)(l.code,{children:"<PcapPlusPlus_Dir>

1/Tests/Pcap++Test/Bin/Pcap++Test"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,n.jsx)(l.p,{children:"The following configuration options are available (on top of CMake's built-in options):"}),"\n",(0,n.jsxs)(l.table,{children:[(0,n.jsx)(l.thead,{children:(0,n.jsxs)(l.tr,{children:[(0,n.jsx)(l.th,{style:{textAlign:"left"},children:"Option"}),(0,n.jsx)(l.th,{style:{textAlign:"left"},children:"Description"})]})}),(0,n.jsxs)(l.tbody,{children:[(0,n.jsxs)(l.tr,{children:[(0,n.jsx)(l.td,{style:{textAlign:"left"},children:(0,n.jsx)(l.strong,{children:(0,n.jsx)(l.code,{children:"-DPCAPPP_USE_PCAP=<ON/OFF>"})})}),(0,n.jsxs)(l.td,{style:{textAlign:"left"},children:["Build PcapPlusPlus with libpcap support (default value is ",(0,n.jsx)(l.code,{children:"ON"}),")"]})]}),(0,n.jsxs)(l.tr,{children:[(0,n.jsx)(l.td,{style:{textAlign:"left"},children:(0,n.jsx)(l.strong,{children:(0,n.jsx)(l.code,{children:"-DPCAPPP_BUILD_EXAMPLES=<ON/OFF>"})})}),(0,n.jsxs)(l.td,{style:{textAlign:"left"},children:["Build PcapPlusPlus examples (default value is ",(0,n.jsx)(l.code,{children:"ON"})," if building the project itself, otherwise ",(0,n.jsx)(l.code,{children:"OFF"}),")"]})]}),(0,n.jsxs)(l.tr,{children:[(0,n.jsx)(l.td,{style:{textAlign:"left"},children:(0,n.jsx)(l.strong,{children:(0,n.jsx)(l.code,{children:"-DPCAPPP_BUILD_TESTS=<ON/OFF>"})})}),(0,n.jsxs)(l.td,{style:{textAlign:"left"},children:["Build PcapPlusPlus tests (default value is ",(0,n.jsx)(l.code,{children:"ON"})," if building the project itself, otherwise ",(0,n.jsx)(l.code,{children:"OFF"}),")"]})]}),(0,n.jsxs)(l.tr,{children:[(0,n.jsx)(l.td,{style:{textAlign:"left"},children:(0,n.jsx)(l.strong,{children:(0,n.jsx)(l.code,{children:"-DPCAPPP_BUILD_TUTORIALS=<ON/OFF>"})})}),(0,n.jsxs)(l.td,{style:{textAlign:"left"},children:["Build PcapPlusPlus tutorials. This option is only available if ",(0,n.jsx)(l.code,{children:"DPCAPPP_BUILD_EXAMPLES=ON"}),". The tutorials binaries will be under ",(0,n.jsx)(l.code,{children:"build/tutorials_bin"})," (default value is ",(0,n.jsx)(l.code,{children:"OFF"}),")"]})]}),(0,n.jsxs)(l.tr,{children:[(0,n.jsx)(l.td,{style:{textAlign:"left"},children:(0,n.jsx)(l.strong,{children:(0,n.jsx)(l.code,{children:"-DPCAPPP_INSTALL=<ON/OFF>"})})}),(0,n.jsxs)(l.td,{style:{textAlign:"left"},children:["Install PcapPlusPlus (default value is ",(0,n.jsx)(l.code,{children:"ON"})," if building the project itself, otherwise ",(0,n.jsx)(l.code,{children:"OFF"}),")"]})]}),(0,n.jsxs)(l.tr,{children:[(0,n.jsx)(l.td,{style:{textAlign:"left"},children:(0,n.jsx)(l.strong,{children:(0,n.jsx)(l.code,{children:"-DBUILD_SHARED_LIBS=<ON/OFF>"})})}),(0,n.jsxs)(l.td,{style:{textAlign:"left"},children:["Build shared libs (default value is ",(0,n.jsx)(l.code,{children:"OFF"}),")"]})]}),(0,n.jsxs)(l.tr,{children:[(0,n.jsx)(l.td,{style:{textAlign:"left"},children:(0,n.jsx)(l.strong,{children:(0,n.jsx)(l.code,{children:"-DPCAPPP_BUILD_PCAPPP=<ON/OFF>"})})}),(0,n.jsxs)(l.td,{style:{textAlign:"left"},children:["Build the Pcap++ library (default value is ",(0,n.jsx)(l.code,{children:"ON"}),"). Turning it off will only build Common++ and Packet++ and avoid third-party dependencies such as libpcap or WinPcap/Npcap"]})]}),(0,n.jsxs)(l.tr,{children:[(0,n.jsx)(l.td,{style:{textAlign:"left"},children:(0,n.jsx)(l.strong,{children:(0,n.jsx)(l.code,{children:"-DPCAPPP_LOG_LEVEL=<0/1/2/3>"})})}),(0,n.jsxs)(l.td,{style:{textAlign:"left"},children:["Set compile time log level: Off (",(0,n.jsx)(l.code,{children:"0"}),"), Error (",(0,n.jsx)(l.code,{children:"1"}),"), Info (",(0,n.jsx)(l.code,{children:"2"}),"), Debug (",(0,n.jsx)(l.code,{children:"1"}),") (Default value is ",(0,n.jsx)(l.code,{children:"Debug"}),")"]})]})]})]}),"\n",(0,n.jsx)(l.h2,{id:"installation",children:"Installation"}),"\n",(0,n.jsx)(l.p,{children:"After the build is complete you can run the installation script which will copy the libraries, header files and examples into the installation directories:"}),"\n",(0,n.jsx)(l.pre,{children:(0,n.jsx)(l.code,{className:"language-shell",children:"sudo cmake --install .\n"})}),"\n",(0,n.jsx)(l.p,{children:"If you want to install on a non-default directory you can use this command:"}),"\n",(0,n.jsx)(l.pre,{children:(0,n.jsx)(l.code,{className:"language-shell",children:'DESTDIR=<DIR> cmake --install build --prefix "/"\n'})}),"\n",(0,n.jsx)(l.h2,{id:"running-tests",children:"Running tests"}),"\n",(0,n.jsxs)(l.p,{children:["PcapPlusPlus contains a set of test-cases you can run to make sure that everything works correctly on your system. ",(0,n.jsx)(l.a,{href:"../tests",children:"This guide"})," contains detailed instructions on how to run them."]})]})}function h(e={}){const{wrapper:l}={...(0,t.R)(),...e.components};return l?(0,n.jsx)(l,{...e,children:(0,n.jsx)(a,{...e})}):a(e)}},8453(e,l,s){s.d(l,{R:()=>d,x:()=>r});var i=s(6540);const n={},t=i.createContext(n);function d(e){const l=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(l):{...l,...e}}),[l,e])}function r(e){let l;return l=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:d(e.components),i.createElement(t.Provider,{value:l},e.children)}}}]);