pax_global_header00006660000000000000000000000064147606357410014527gustar00rootroot0000000000000052 comment=00930870c6794c1d6d632f483dde042f8ede764c knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/000077500000000000000000000000001476063574100201615ustar00rootroot00000000000000knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/.astylerc000066400000000000000000000000361476063574100220070ustar00rootroot00000000000000--style=gnu --indent=spaces=2 knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/.github/000077500000000000000000000000001476063574100215215ustar00rootroot00000000000000knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/.github/workflows/000077500000000000000000000000001476063574100235565ustar00rootroot00000000000000knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/.github/workflows/ci.yml000066400000000000000000000053701476063574100247010ustar00rootroot00000000000000name: CI on: push: branches: "*" pull_request: branches: "*" permissions: {} jobs: # On Ubuntu, because that is the standard OS of GitHub Actions. build_ubuntu: runs-on: ubuntu-latest steps: - name: Install build dependencies run: | sudo apt-get update sudo apt-get dist-upgrade -y sudo apt-get install -y --no-install-recommends libusb-1.0-0-dev libsystemd-dev libev-dev libfmt-dev libinih-dev - uses: actions/checkout@v4 with: fetch-depth: 0 # Full history to be able to determine version number - name: Bootstrap run: sh bootstrap.sh - name: Configure run: ./configure - name: Build run: make -j$(nproc) - name: Test run: make -j1 test - name: Install run: sudo make -j1 install # On Alpine, because it's a tiny distro heavily used in containers. build_alpine: runs-on: ubuntu-latest container: alpine steps: - name: Install build dependencies run: | apk update apk upgrade apk add git build-base autoconf automake libtool argp-standalone linux-headers libusb-dev libev-dev fmt-dev inih-dev - name: Configure git in container run: | git config --global --add safe.directory "$GITHUB_WORKSPACE" - uses: actions/checkout@v4 with: fetch-depth: 0 # Full history to be able to determine version number - name: Bootstrap run: sh bootstrap.sh - name: Configure run: ./configure --disable-systemd - name: Build run: make -j$(nproc) - name: Test run: make -j1 test - name: Install run: make -j1 install # Debian packaging; May break when code changes require updates to the Debian package. # Merges the pushed/proposed code changes to the `debian` branch and builds that then. package_debian: strategy: fail-fast: false matrix: suite: [testing, stable, oldstable] runs-on: ubuntu-latest container: debian:${{ matrix.suite }}-slim steps: - name: Install dependencies run: | apt-get update apt-get dist-upgrade -y apt-get autoremove -y --purge apt-get install -y --no-install-recommends ca-certificates git sudo - name: Configure git in container run: | git config --global --add safe.directory "$GITHUB_WORKSPACE" git config --global user.name "Your Name" git config --global user.email "you@example.com" - uses: actions/checkout@v4 with: fetch-depth: 0 # Full history to be able to determine version number - name: Merge with debian branch run: | git switch -C ci origin/debian git merge origin/main - name: Build and install run: sh install-debian.sh knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/.gitignore000066400000000000000000000062511476063574100221550ustar00rootroot00000000000000/debian/ *~ *.swp *.la *.a *.o *.lo *.pyc *.pyo *.deps/ Makefile.in Makefile .libs /COPYING /INSTALL /aclocal.m4 /compile /config.guess /config.h /config.h.in /config.log /config.status /config.sub /configure /confdefs.h /depcomp /doc /install-sh /libtool /libev/ /libfmt/ /ltmain.sh /missing /path.h /autom4te.cache /autom4te.cache/ /stamp-h1 /version.h /m4/libtool.m4 /m4/ltoptions.m4 /m4/ltsugar.m4 /m4/ltversion.m4 /m4/lt~obsolete.m4 /src/client/c/gen/ /src/client/cs/EIBConnection.cs /src/client/cs/EIBConnection.post /src/client/cs/result.inc /src/client/lua/EIBConnection.lua /src/client/lua/gen /src/client/lua/gen.inc /src/client/lua/result.inc /src/client/pascal/EIBD.pas /src/client/pascal/gen /src/client/pascal/gen.inc /src/client/pascal/genh /src/client/pascal/genh.inc /src/client/pascal/result.inc /src/client/perl/EIBConnection.p /src/client/perl/EIBConnection.p1 /src/client/perl/EIBConnection.pm /src/client/perl/EIBConnection.post /src/client/perl/result.inc /src/client/php/EIBConnection.php /src/client/php/EIBConnection.post /src/client/php/eibclient.php /src/client/php/result.inc /src/client/python/EIBConnection.py /src/client/python/gen /src/client/python/gen.inc /src/client/python/result.inc /src/client/ruby/gen /src/client/ruby/gen.inc /src/client/ruby/result.inc /src/client/ruby/EIBConnection.rb /src/client/go/EIBConnection.go /src/client/go/gen /src/client/go/gen.inc /src/client/go/result.inc /src/examples/busmonitor1 /src/examples/busmonitor2 /src/examples/busmonitor3 /src/examples/groupcacheclear /src/examples/groupcachedisable /src/examples/groupcacheenable /src/examples/groupcachelastupdates /src/examples/groupcacheread /src/examples/groupcachereadsync /src/examples/groupcacheremove /src/examples/grouplisten /src/examples/groupread /src/examples/groupreadresponse /src/examples/groupresponse /src/examples/groupsocketlisten /src/examples/groupsocketread /src/examples/groupsocketswrite /src/examples/groupsocketwrite /src/examples/groupsresponse /src/examples/groupswrite /src/examples/groupwrite /src/examples/madcread /src/examples/maskver /src/examples/mmaskver /src/examples/mpeitype /src/examples/mprogmodeoff /src/examples/mprogmodeon /src/examples/mprogmodestatus /src/examples/mprogmodetoggle /src/examples/mpropdesc /src/examples/mpropread /src/examples/mpropscan /src/examples/mpropscanpoll /src/examples/mpropwrite /src/examples/mread /src/examples/mrestart /src/examples/msetkey /src/examples/mwrite /src/examples/mwriteplain /src/examples/progmodeoff /src/examples/progmodeon /src/examples/progmodestatus /src/examples/progmodetoggle /src/examples/readindividual /src/examples/vbusmonitor1 /src/examples/vbusmonitor1poll /src/examples/vbusmonitor1time /src/examples/vbusmonitor2 /src/examples/vbusmonitor3 /src/examples/writeaddress /src/examples/xpropread /src/examples/xpropwrite /src/server/knxd /src/server/knxd_args /src/tools/eibread-cgi /src/tools/eibwrite-cgi /src/tools/knxtool /src/tools/bcu/bcuaddrtab /src/tools/bcu/bcuread /src/tools/eibnet/eibnetdescribe /src/tools/eibnet/eibnetsearch /src/usb/findknxusb /systemd/*.service /systemd/*.socket /tools/test_inih /src/examples/eibread-cgi /src/examples/eibwrite-cgi /src/examples/knxtool /systemd/knxd.service.exp knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/.gitmodules000066400000000000000000000000001476063574100223240ustar00rootroot00000000000000knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/.mailmap000066400000000000000000000017531476063574100216100ustar00rootroot00000000000000Stefan Hoffmeister Michael Markstaller Joerg Mattiello Patrik Pfaffenbauer Timo Wingender Matthias Urlichs Matthias Urlichs Matthias Urlichs root Lars Tolkmitt akellai akellai Thomas Dallmair Matthias Fechner Matthias Richard Hartmann Michael Kefeder Trond Kjeldås Trond Kjeldås Harald Leithner Harald knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/.vimrc000066400000000000000000000001271476063574100213020ustar00rootroot00000000000000set sw=2 ts=8 set cindent cinoptions=>2s,n-1s,{1s,Ls,g1s,^-1s cinkeys=0{,},:,!^F,o,O,e knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/AUTHORS000066400000000000000000000045661476063574100212440ustar00rootroot00000000000000Alphabetical list of surnames of everyone who ever committed to this repository. Auto-generated by tools/list_AUTHORS and .mailmap dimnij <63244636+dimnij@users.noreply.github.com> akellai Michael Albert Matthias Alphart Enrik Berkhan bmxp HeySora Thomas Dallmair Tobias Deiminger Matthias Fechner Meik Felser Sven Fischer Andreas Frisch Eduard Fuchs StalderT Simón Golpe <33048138+Golpe82@users.noreply.github.com> Marcus Haehnel hari2 Richard Hartmann henfri Stefan Hoffmeister J-N-K Marc Joliet jrester jsauermann Elias Karakoulakis kbernloehr Michael Kefeder Steffen Kieß Trond Kjeldås Claus Klingberg Martin Koegler Gregor Krmelj Ole Krüger Harald Leithner Tobias Lorenz MagicBear Michael Markstaller Joerg Mattiello Race666 Sebastian Ole buergi Patrik Pfaffenbauer Joakim Plate Stephan Reinhard Richard Schleich shakaraba Greig Sheridan smaiLee SystemTera Tharre Lars Tolkmitt Henning Treu Othmar Truniger Matthias Urlichs Sergey V. Lobanov Christian Wicke Timo Wingender Paweł Żabiełowicz knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/ChangeLog000066400000000000000000000000371476063574100217330ustar00rootroot00000000000000# dummy file. I HATE AUTOMAKE. knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/CodingStyle.md000066400000000000000000000016671476063574100227410ustar00rootroot00000000000000# KNXD Coding Style KNXD is written in C++. It has originally been formatted using "indent", which unfortunately knows only C but next to nothing about C++, thus some of the spacing in the code doesn't look at all like idiomatic C++. Please try to adhere to the formatting of existing code as much as possible, or at least as much as you're comfortable with. Specifically, please adhere to the two/four-space indent scheme: if (x) { more_statements; more_statements; } else single_statement; ## "#ifdef"s All "#ifdef" statements should be either * guard macros (#ifndef foo / #define foo … / #endif) * conditional on a specific compiler (cf. "#ifdef __gnuc__" in src/common/types.h) * conditional on "HAVE_XXX" as discovered by autoconf. Operating system specific conditionals are not allowed: they tend to stop working when you switch compilers, cross-compile, or build with an alternate libc. knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/LICENSE000066400000000000000000000431531476063574100211740ustar00rootroot00000000000000GNU GENERAL PUBLIC LICENSE Version 2, June 1991 Copyright (C) 1989, 1991 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. GNU GENERAL PUBLIC LICENSE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following: a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances. It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS How to Apply These Terms to Your New Programs If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. {description} Copyright (C) {year} {fullname} This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Also add information on how to contact you by electronic and paper mail. If the program is interactive, make it output a short notice like this when it starts in an interactive mode: Gnomovision version 69, Copyright (C) year name of author Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. This is free software, and you are welcome to redistribute it under certain conditions; type `show c' for details. The hypothetical commands `show w' and `show c' should show the appropriate parts of the General Public License. Of course, the commands you use may be called something other than `show w' and `show c'; they could even be mouse-clicks or menu items--whatever suits your program. You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names: Yoyodyne, Inc., hereby disclaims all copyright interest in the program `Gnomovision' (which makes passes at compilers) written by James Hacker. {signature of Ty Coon}, 1 April 1989 Ty Coon, President of Vice This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/Makefile.am000066400000000000000000000015301476063574100222140ustar00rootroot00000000000000AUTOMAKE_OPTIONS=1.9 ACLOCAL_AMFLAGS = -I m4 EXTRA_DIST=SubmittingPatches .gitignore tools/version.sh ## rebuild when the version changes BUILDDIRS = SUBDIRS=. src systemd DIST_SUBDIRS = $(SUBDIRS) BUILT_SOURCES=path.h version.h CLEANFILES=path.h version.h path.h : Makefile echo "#define PKGDATADIR \"${pkgdatadir}\"" >$@ echo "#define PKGLIBDIR \"${pkglibdir}\"" >>$@ .PHONY: CHECK version.h: CHECK echo "#define REAL_VERSION \"${shell tools/version.sh}\"" >>$@.new cmp -s $@.new $@ && rm $@.new || mv $@.new $@ .PHONY: help HELP help HELP: @echo "" @echo "" @echo "in addition to standard targets (all, install, clean, ...)" @echo "the following make targets may be supported (at this level):" @echo "" @echo " make help - print this text" @echo "" # update version number config.h: configure test: all sh tools/test.sh knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/NEWS000066400000000000000000000000371476063574100206600ustar00rootroot00000000000000# dummy file. I HATE AUTOMAKE. knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/README000066400000000000000000000001341476063574100210370ustar00rootroot00000000000000# dummy file. Automake is dumb. # # If you're not Automake: Please read README.md instead. knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/README.md000066400000000000000000000344621476063574100214510ustar00rootroot00000000000000knxd [![CI](https://github.com/knxd/knxd/actions/workflows/ci.yml/badge.svg)](https://github.com/knxd/knxd/actions/workflows/ci.yml) ==== KNX is a very common building automation protocol which runs on dedicated 9600-baud wire as well as IP multicast. ``knxd`` is an advanced router/gateway which runs on any Linux computer; it can talk to all known KNX interfaces. # STOP if you install on Debian (or Ubuntu or …) Debian/Ubuntu packaging has moved to the ``debian`` branch. Please use that branch (by way of ``git checkout debian``) if you're following some (outdated …) installation instructions for Debian, Ubuntu or their derivatives. In the ``debian`` branch, this file contains build instructions for Debian. # Stable version This version should be OK for general use. Check [the Wiki page](https://github.com/knxd/knxd/wiki) for other version(s) to use. ## Known bugs * ETS programming may or may not work out of the box. You might need to use the `single` filter in front of your KNX interface. ## Configuration ### Daemon Configuration Daemon configuration differs depending on whether you use systemd. If "systemctl status" emits something reasonable, you are. If you use Linux and systemd, the configuration file is ``/etc/knxd.conf``. Socket activation is used for the default IP and Unix sockets (port 6720 and /run/knx, respectively). If not, the location of your configuration file depends on your init system. In ``knxd`` or ``knxd.conf``, KNXD\_OPTS can be set to either the legacy command line arguments, or the location of the new .ini (e.g. ``KNXD_OPTS=/etc/knxd.ini``) ### New ".ini" configuration file knxd is typically started with "knxd /etc/knxd.ini". The file format is documented in "doc/inifile.rst". You might want to use the program "/usr/lib/knxd\_args" to create it from previous versions' command-line arguments. ### Backward Compatibility The default Unix socket is ``/run/knx``. Old eibd clients may still use ``/tmp/eib`` to talk to knxd. You need to either change their configuration, or add "-u /tmp/eib" to knxd's options. (This was the default for "-u" before version 0.11.) ## New Features since 0.12 ### see https://github.com/knxd/knxd/blob/v0.12/README.md for earlier changes * 0.14.41 * speed up CGI initial setup (a lot) * support another USB interface * found another uninitialized variable * 0.14.39 * Fixed two problems with the "pace" filter that resulted in excessive delays. * 0.14.38 * knxd's udev rules were lost in the Debian branch. Restored (to systemd subdir). * 0.14.37 * Fix a memory leak in the FT12 driver * fix the console rule in README * 0.14.35 * Fixes for FreeBSD * 0.14.34 * Cleanup: remove debian packaging, will be in a separate branch * 0.14.33 * There is a new "retry" filter which controls closing and re-opening a misbehaving driver. This filter is implicitly auto-inserted in front of a driver. * Internal: Driver errors are now signalled with "stopped(true)" instead of "errored" which reduces code duplication. * Default timeout for EMI acks increased to 2 seconds Some USB interfaces manage to be abysmally slow Also hopefully-fixed USB retry and shutdown handling so that the "retry" filter can do its work. * Replies from devices in programming mode are no longer retransmitted to the originating interface. * 0.14.32 * Tags no longer use a leading 'v'. * udev rule for SATEL USB interface * 0.14 * Code configuration * There are no longer separate --enable-tpuarts and --enable-tpuarttcp options. Instead, you control both with --enable-tpuart. (This is the default anyway.) * Configuration file * includes a translator (knxd\_args) from options to config file * All settings are still usable via the command line * Complete stack refactored * You may now use global filters. * USB handling updated * Most device-specific drivers are now split into a top part which translates KNX packets to wire format (usually CEMI), and a bottom part which transmits/receives the actual data. This enables extensive code sharing; knxd also can use TCP connections instead of actual serial devices. * Startup sequencing fixed: KNX packets will not be routed until all interfaces are ready. Also, systemd will not be signalled until then. * Configuration options to not start, or start and ignore failures of, specific interfaces * knxd will now retry setting up an interface * use libfmt for sane and type-safe formatting of error and trace messages * packet-level "logging" calls in various drivers have been removed * logging packets is now done with the new "log" filter * Logging of complete packets (inconsistently bit 1, 2, or 8 of the tracing mask) has been removed This also applies to global packet logging. * Complain loudly (and early) if knxd needs -E / client-addrs=X.Y.Z:N * knxd can restart links when they fail, or start to come up. * Interfaces are now either used normally, or in bus monitor mode. This is set in the configuration file / on the command line. There is no longer a way to switch between these modes; "knxtool busmonitor" will no longer change the state of any interface. * Queuing and flow control Previously, all drivers implemented their own queueing for outgoing packets, resulting in duplicate code and hidden errors. In v0.14, the main queueing system will pace packets for the slowest device. If you don't want that, use the "queue" filter on the slow device(s). All queues in individual drivers have been removed. * EMI handling refactored This eliminated some common code, found a couple of bugs, and lets us use a common logging module (controlled by bit 0 of the tracing mask) for comprehensive packet debugging. 0.12 * knxd was rewritten to use libev instead of pthsem. * knxd now supports multiple interfaces, back-ends, and KNX packet filters. ## History This code is a fork of eibd 0.0.5 (from bcusdk) https://www.auto.tuwien.ac.at/~mkoegler/index.php/bcusdk For a (german only) history and discussion why knxd emerged, please also see: [eibd(war bcusdk) Fork -> knxd](http://knx-user-forum.de/forum/öffentlicher-bereich/knx-eib-forum/39972-eibd-war-bcusdk-fork-knxd) ## Building When in doubt, please check out the branch corresponding to your Linux distribution's flavor, and read this section there. This part covers "manual" installation. # first, install build tools and dependencies. You need git, autotools, and gcc/g++. #: check your Linux distribution's documentation if you don't know how # You also need a "knxd" user. # get the source code git clone https://github.com/knxd/knxd.git # build+install knxd cd knxd git checkout main sh bootstrap.sh ./configure --help ./configure --your-chosen-options make -j$(nproc) make install cd .. # Now switch to the "knxd" user and start the daemon. If you would like to submit patches for Mac OSX or Windows, go ahead and create a pull request, but please be prepared to maintain your code. ### Adding a TPUART USB interface (serial, USB) If you attach a (properly programmed) TUL (http://busware.de/tiki-index.php?page=TUL) to your computer, it'll show up as ``/dev/ttyACM0``. This is a problem because (a) it's owned by root, thus knxd can't access it, and (b) if you ever add another serial interface that uses the same driver, knxd will use the wrong device. Therefore, you do this: * Run ``udevadm info --attribute-walk /sys/bus/usb/drivers/cdc_acm/*/tty/ttyACM0``. We're interested in the third block. It contains a line ``ATTRS{manufacturer}=="busware.de"``. Note the ``KERNELS=="something"`` line (your ``something`` will be different). * Copy the following line to ``/etc/udev/rules.d/70-knxd.rules``: ``` ACTION=="add", SUBSYSTEM=="tty", ATTRS{idVendor}=="03eb", ATTRS{idProduct}=="204b", KERNELS=="something", SYMLINK+="knx1", OWNER="knxd" ``` Of course you need to replace the ``something`` with whatever ``udevadm`` displayed. An example file should be in ``/lib/udev/rules.d/``. * Run ``udevadm test /sys/bus/usb/drivers/cdc_acm/*/tty/ttyACM0``. * verify that ``/dev/knx1`` exists and belongs to "knxd": ``ls -lL /dev/knx1`` * add ``-b tpuarts:/dev/knx1`` to the options in ``/etc/knxd.conf``. If you have a second TPUART, repeat with "ttyACM1" and "knx2". You'll have to update your rule if you ever plug your TPUART into a different USB port. This is intentional. ### Adding some other USB interface These interfaces should be covered by the `udev` file knxd installs in ``/lib/udev/rules.d``. Simply use ``-b usb:`` to talk to it, assuming you don't have more than one. If your interface isn't covered by our udev file, please add its vendor+product and send us a patch. ### Adding a TPUART (Pi HAT) interface to the Raspberry Pi On the Raspberry Pi 2 and 3 the console is /dev/ttyAMA0. The udev line is: ``` ACTION=="add", SUBSYSTEM=="tty", KERNELS=="ttyAMA0", SYMLINK+="knx1", OWNER="knxd" ``` On the Raspberry Pi 4 the console is on /dev/ttyACM0. The udev line is: ``` ACTION=="add", SUBSYSTEM=="tty", KERNELS=="ttyACM0", SYMLINK+="knx1", OWNER="knxd" ``` This rule creates a symlink ``/dev/knx1`` which points to the console. The knxd configuration will use that symlink. On the Raspberry Pi 2 and 3 you need to disable the kernel's serial console. Edit ``/boot/cmdline.txt`` and remove the ``console=ttyAMA0`` entry. Then reboot. On the Raspberry Pi 3, the serial console is on ``ttyAMA1`` by default. However, that is a software-driven serial port – the hardware serial interface is used for Bluetooth on the Pi3. Varying CPU speed causes this port to be somewhat unreliable. You should disable Bluetooth by adding ``` dtoverlay=pi3-disable-bt ``` to ``/boot/config.txt``, run ``systemctl disable hciuart``, and reboot. The console and the TPUART module is now back on ``ttyAMA0``. ## Migrating to 0.14 * If you build knxd yourself: install the ``libfmt-dev`` package, if possible. The knxd build process will try to download and build libfmt when that package is not present. * knxd is now configured with a .ini-style configuration file. The old way of configuring knxd via a heap of position-dependent arguments is still supported. You can use ``/usr/lib/knxd_args `` to emit a .ini file that corresponds to your old list of arguments. * Not configuring client addresses is now a hard error. Knxd will no longer multiplex its clients onto its own address. * knxd will not start routing any packets unless startup is successful on all interfaces. This means that it is now safe to use "socket activation" mode with systemd. Previously, knxd might have lost the initial packets. * knxd can now attach filters to a single interface, or to the core (i.e. all packets get filtered). * Tracing no longer logs the actual decoded contents of packet. If you need that, use a "log" filter appropriately. * knxd now transmits data synchronously, i.e. individual drivers no longer buffer data for transmission. If you don't want that, use the "queue" filter on slow interfaces. ## Migrating to 0.12 * If you build knxd yourself: install the ``libev-dev`` package. You no longer need the ``pthsem`` packages. * You may need "-B single" in front of any "-b ipt:" or "-b usb:", esp. when you need to program a device; normal use is often not affected. knxd emits a warning ``Message without destination. Use the single-node filter ('-B single')?`` when it detects mis-addressed packets. * You need "-e"; knxd no longer defaults to address 0.0.1. * You need "-E" if you want to allow clients to connect (options -u -i -T). As that's almost always the case, knxd will print a warning if this option is missing. * If you use knxtool's management tools (any command with "progmode" or whose name starts with 'm'), please [open an issue](https://github.com/knxd/knxd/issues) because knxd currently does not support these commands. ## Migrating from ``eibd`` * Before you build knxd: remove *any* traces of the old eibd installation from ``/usr/local``, or wherever you installed it. * The order of arguments is now significant. Among the "-D -T -R -S" arguments, ``-S`` must occur *last*. Arguments which modify the behavior of an interface must be in front of that interface. Global arguments (e.g. tracing the datagram router) must be in front of the "-e" option. * The 'groupswrite' etc. aliases are no longer installed by default. To workaround, you can either add ``/usr/lib/knxd`` to your ``$PATH``, or use ``knxtool groupswrite``. * If you use Debian Jessie or another systemd-based distribution, ``/lib/systemd/system/knxd.socket`` is used to open the "standard" sockets on which knxd listens to clients. You no longer need your old ``-i`` or ``-u`` options. * knxd's Unix socket should never have been located in ``/tmp``; the default is now ``/run/knx``. You can add a "-u /tmp/eib" (or whatever) option if necessary, but it's better to fix the clients. ## Contributions * Contributions are *very* welcome * Please use Github and create a pull request with your patches. * Please see SubmittingPatches to correctly Sign-Off your code and add yourself to AUTHORS (`tools/list_AUTHORS > AUTHORS`) * Adhere to our [coding conventions](https://github.com/knxd/knxd/wiki/CodingConventions). * The git archive includes a helpful .vimrc file if you use VIM. ### Compensation – personal statement KNX development is not a simple matter and requires both time and dedicated hardware for tests. The ETS software isn't exactly cheap, either, and there is no free replacement. (I'd like to change that, but time is fleeting.) Thus, wearing my hat as the (current) main author, I (Matthias Urlichs) would like to ask you to consider contributing to knxd's development. * [Github](https://github.com/sponsors/smurfix) * [LiberaPay](https://liberapay.com/knxd/) * Paypal: urlichs@m-u-it.de * SEPA: DE34430609671145580100 @ GENODEM1GLS * Ethereum: please ask * Bitcoin: please don't waste power I can issue a commercial invoice if required. If you'd rather gift some hardware, please ask. ## Community * Code-related issues (aka "bugs") are on GitHub: https://github.com/knxd/knxd/issues * For everything else there's a Google Groups forum on https://groups.google.com/forum/#!forum/knxd knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/SubmittingPatches.md000066400000000000000000000034401476063574100241410ustar00rootroot00000000000000# Guidelines for patch submission To document, where patches come from without to much overhead, please add a "sign-off" to your patches/commits. The sign-off is a simple line at the end of the explanation for the patch. It certifies that you wrote it or otherwise have the right to pass it on as a open-source patch. The rules are pretty simple: if you can certify this: ## Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved. then you just add a line saying Signed-off-by: Random J Developer using your real name (sorry, no pseudonyms or anonymous contributions.) This sign-off procedure is used by other projects, e.g. kernel.org or git. This text is derived from their versions of signoff handling. knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/bootstrap.sh000066400000000000000000000012141476063574100225300ustar00rootroot00000000000000#!/bin/sh if test -f /usr/local/lib/libeibclient.so.0 ; then echo "*** You have old eibd libraries lying around in /usr/local/lib." >&2 echo "*** Remove them before building or installing knxd." >&2 exit 1 fi case `uname` in Darwin*) LIBTOOLIZE=glibtoolize ;; *) LIBTOOLIZE=libtoolize ;; esac # on Debian systems we need pkg-config if which dpkg >/dev/null && ! which pkg-config >/dev/null ; then echo "Tool 'pkg-config' missing. Install package 'pkgconf' or older 'pkg-config'." exit 2 fi $LIBTOOLIZE --copy --force --install && \ aclocal -I m4 --force && \ autoheader && \ automake --add-missing --copy --force-missing && \ autoconf knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/configure.ac000066400000000000000000000300031476063574100224430ustar00rootroot00000000000000dnl ## BCU SDK bcu development enviroment - autoconf & automake files dnl ## Copyright (C) 2005-2011 Martin Koegler dnl ## dnl ## Redistribution and use in source and binary forms, with or without dnl ## modification, are permitted provided that the following conditions dnl ## are met: dnl ## 1. Redistributions of source code must retain the above copyright dnl ## notice, this list of conditions and the following disclaimer. dnl ## 2. Redistributions in binary form must reproduce the above copyright dnl ## notice, this list of conditions and the following disclaimer in the dnl ## documentation and/or other materials provided with the distribution. dnl ## dnl ## THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND dnl ## ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE dnl ## IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE dnl ## ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE dnl ## FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL dnl ## DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS dnl ## OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) dnl ## HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT dnl ## LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY dnl ## OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF dnl ## SUCH DAMAGE. AC_PREREQ([2.69]) LT_PREREQ([2.2.0]) AC_INIT([knxd],m4_esyscmd_s([./tools/version.sh])) AC_CONFIG_SRCDIR([src/server/knxd.cpp]) AM_INIT_AUTOMAKE LT_INIT AC_CANONICAL_HOST AC_PROG_CC AC_PROG_CXX AC_LANG([C++]) dnl Oh come on Apple ... case $host in *-*-darwin*) link_force_option=",-force_load" link_all_option="" no_link_all_option="" ;; *) link_force_option="" link_all_option=",--whole-archive" no_link_all_option=",--no-whole-archive" ;; esac AC_SUBST(LINK_FORCE,$link_force_option) AC_SUBST(LINK_ALL,$link_all_option) AC_SUBST(NO_LINK_ALL,$no_link_all_option) AC_CHECK_HEADERS([sys/time.h sys/select.h]) AX_CXX_COMPILE_STDCXX(11) GMP_PROG_CPP_FOR_BUILD GMP_PROG_EXEEXT_FOR_BUILD CC_FOR_BUILD_OPTS dnl AC_COMPILER_OPTION(nortti,[-fno-rtti],[-fno-rtti],CXXFLAGS="$CXXFLAGS -fno-rtti") AC_COMPILER_OPTION(stdc,[-std=c++0x],[-std=c++0x],CXXFLAGS="$CXXFLAGS -std=c++0x -Wno-subobject-linkage") dnl libev++ requires exceptions dnl AC_COMPILER_OPTION(noexceptions,[-fno-exceptions],[-fno-exceptions],CXXFLAGS="$CXXFLAGS -fno-exceptions") AX_LOCAL_EXPAND_CONFIG AX_ENABLE_SYSTEMD AC_CHECK_HEADER(argp.h,,[AC_MSG_ERROR([argp_parse not found])]) AC_SEARCH_LIBS(argp_parse,argp,,[AC_MSG_ERROR([argp_parse not found])]) dnl does not seem to work correctly. Disabled. dnl AC_CHECK_HEADER(linux/serial.h,[AC_DEFINE(HAVE_LINUX_LOWLATENCY, 1 , [Linux low latency mode enabled])],[AC_MSG_WARN([No supported low latency mode found])]) have_source_info=no have_linux_api=no AC_CHECK_HEADER(linux/rtnetlink.h,[AC_DEFINE(HAVE_LINUX_NETLINK, 1,[Linux netlink layer available]) have_source_info=yes],[],[]) AC_CHECK_HEADER(linux/usbdevice_fs.h,[AC_DEFINE(OS_LINUX, 1, [Linux usb available]) have_linux_api=yes; have_usb=yes],[],[]) AC_CHECK_HEADER(iphlpapi.h,[AC_DEFINE(HAVE_WINDOWS_IPHELPER, 1,[Windows IPHelper available]) LIBS="-liphlpapi $LIBS"; have_source_info=yes],[],[]) AC_CHECK_HEADER(ini.h,[AC_DEFINE(HAVE_LIBINIH, 1,[libinih available]) have_inih=yes],[],[]) AM_CONDITIONAL(HAVE_INIH, test x$have_inih = xyes) AC_CHECK_DECL(SA_SIZE,[AC_DEFINE(HAVE_SA_SIZE, 1,[SA_SIZE function available])],[],[ #include #include #include #include ]) have_bsd_source_info=no AC_CHECK_DECL(__FreeBSD__,[have_bsd_source_info=yes],[],[]) AC_CHECK_DECL(__APPLE__,[have_bsd_source_info=yes],[],[]) if test x$have_bsd_source_info = xyes ; then AC_DEFINE(HAVE_BSD_SOURCEINFO, 1,[FreeBSD compatible sourceinfo]) have_source_info=yes fi AC_CHECK_FUNCS(gethostbyname_r,,[AC_MSG_WARN([knxd client library not thread safe])]) AM_CONDITIONAL(LINUX_API, test x$have_linux_api = xyes) AC_DEFUN([NEED_EMI], [dnl need_emi=yes AC_MSG_RESULT([EMI because of $1]) ]) AC_ARG_ENABLE(busmonitor, [ --enable-busmonitor enable bus monitoring], [case "${enableval}" in yes) busmonitor=true ;; no) busmonitor=false ;; *) AC_MSG_ERROR(bad value ${enableval} for --enable-busmonitor) ;; esac],[busmonitor=true]) AM_CONDITIONAL(HAVE_BUSMONITOR, test x$busmonitor = xtrue) if test x$busmonitor = xtrue ; then AC_DEFINE(HAVE_BUSMONITOR, 1 , [bus monitoring enabled]) fi AC_ARG_ENABLE(management, [ --enable-management enable management connections], [case "${enableval}" in yes) management=true ;; no) management=false ;; *) AC_MSG_ERROR(bad value ${enableval} for --enable-management) ;; esac],[management=false]) AM_CONDITIONAL(HAVE_MANAGEMENT, test x$management = xtrue) if test x$management = xtrue ; then AC_DEFINE(HAVE_MANAGEMENT, 1 , [management connections enabled]) fi AC_ARG_ENABLE(ft12, [ --enable-ft12 enable FT1.2 backend], [case "${enableval}" in yes) ft12=true ;; no) ft12=false ;; *) AC_MSG_ERROR(bad value ${enableval} for --enable-ft12) ;; esac],[ft12=true]) AM_CONDITIONAL(HAVE_FT12, test x$ft12 = xtrue) if test x$ft12 = xtrue ; then AC_DEFINE(HAVE_FT12, 1 , [FT1.2 enabled]) NEED_EMI(ft12) fi AC_ARG_ENABLE(dummy, [ --enable-dummy enable do-nothing backend], [case "${enableval}" in yes) dummy=true ;; no) dummy=false ;; *) AC_MSG_ERROR(bad value ${enableval} for --enable-dummy) ;; esac],[dummy=true]) AM_CONDITIONAL(HAVE_DUMMY, test x$dummy = xtrue) if test x$dummy = xtrue ; then AC_DEFINE(HAVE_DUMMY, 1 , [dummy enabled]) fi dnl AC_ARG_ENABLE(pei16s, dnl [ --enable-pei16s enable BCU1 user driver backend (very experimental)], dnl [case "${enableval}" in dnl yes) pei16s=true ;; dnl no) pei16s=false ;; dnl *) AC_MSG_ERROR(bad value ${enableval} for --enable-pei16s) ;; dnl esac],[pei16s=false]) dnl AM_CONDITIONAL(HAVE_PEI16s, test x$pei16s = xtrue) dnl if test x$pei16s = xtrue ; then dnl AC_DEFINE(HAVE_PEI16s, 1 , [PEI16s enabled]) dnl NEED_EMI(pei16s) dnl fi AC_ARG_ENABLE(tpuart, [ --enable-tpuart enable TPUART driver backends], [case "${enableval}" in yes) tpuart=true ;; no) tpuart=false ;; *) AC_MSG_ERROR(bad value ${enableval} for --enable-tpuart) ;; esac],[tpuart=true]) AM_CONDITIONAL(HAVE_TPUART, test x$tpuart = xtrue) if test x$tpuart = xtrue ; then AC_DEFINE(HAVE_TPUART, 1 , [common TPUART code enabled]) fi AC_ARG_ENABLE(eibnetip, [ --enable-eibnetip enable simple multicast EIBnet/IP backend], [case "${enableval}" in yes) eibnetip=true ;; no) eibnetip=false ;; *) AC_MSG_ERROR(bad value ${enableval} for --enable-eibnetip) ;; esac],[eibnetip=true]) AM_CONDITIONAL(HAVE_EIBNETIP, test x$eibnetip = xtrue) if test x$eibnetip = xtrue ; then AC_DEFINE(HAVE_EIBNETIP, 1 , [EIBnet/IP multicast slave enabled]) fi AC_ARG_ENABLE(eibnetserver, [ --enable-eibnetserver enable full-featured EIBnet/IP routing], [case "${enableval}" in yes) eibnetserver=true ;; no) eibnetserver=false ;; *) AC_MSG_ERROR(bad value ${enableval} for --enable-eibnetserver) ;; esac],[eibnetserver=true]) AM_CONDITIONAL(HAVE_EIBNETSERVER, test x$eibnetserver = xtrue) if test x$eibnetserver = xtrue ; then AC_DEFINE(HAVE_EIBNETSERVER, 1 , [EIBnet/IP master enabled]) fi AC_ARG_ENABLE(eibnetiptunnel, [ --enable-eibnetiptunnel enable EIBnet/IP tunneling backend], [case "${enableval}" in yes) eibnetiptunnel=true ;; no) eibnetiptunnel=false ;; *) AC_MSG_ERROR(bad value ${enableval} for --enable-eibnetiptunnel) ;; esac],[eibnetiptunnel=true]) AM_CONDITIONAL(HAVE_EIBNETIPTUNNEL, test x$eibnetiptunnel = xtrue) if test x$eibnetiptunnel = xtrue ; then if test x$have_source_info != xyes ; then AC_MSG_ERROR(not all needed functions for EIBnet/IP tunneling backend available) fi AC_DEFINE(HAVE_EIBNETIPTUNNEL, 1 , [EIBnet/IP tunneling enabled]) fi AC_ARG_ENABLE(usb, [ --enable-usb enable USB backend], [case "${enableval}" in yes) usb=true ;; no) usb=false ;; *) AC_MSG_ERROR(bad value ${enableval} for --enable-usb) ;; esac],[usb=true]) if test x$usb = xtrue ; then PKG_CHECK_MODULES([LIBUSB], [libusb-1.0 >= 1.0.9] , AM_CONDITIONAL(HAVE_USB, test x$usb = xtrue)) if test x$have_usb != xyes ; then AC_MSG_ERROR(not all needed functions for USB backend available) fi AC_DEFINE(HAVE_USB, 1 , [USB backend enabled]) NEED_EMI(usb) else AM_CONDITIONAL(HAVE_USB, test x$usb = xtrue) fi AC_ARG_ENABLE(eibnetipserver, [ --enable-eibnetipserver enable EIBnet/IP server frontend], [case "${enableval}" in yes) eibnetipserver=true ;; no) eibnetipserver=false ;; *) AC_MSG_ERROR(bad value ${enableval} for --enable-eibnetipserver) ;; esac],[eibnetipserver=true]) if test x$eibnetipserver = xtrue ; then if test x$have_source_info != xyes ; then AC_MSG_ERROR(not all needed functions for EIBnet/IP server available) fi AC_DEFINE(HAVE_EIBNETIPSERVER, 1 , [EIBnet/IP server enabled]) fi AC_ARG_ENABLE(groupcache, [ --enable-groupcache enable Group Cache (default: yes)], [case "${enableval}" in yes) groupcache=true ;; no) groupcache=false ;; *) AC_MSG_ERROR(bad value ${enableval} for --enable-groupcache) ;; esac],[groupcache=true]) AM_CONDITIONAL(HAVE_GROUPCACHE, test x$groupcache = xtrue) if test x$groupcache = xtrue ; then AC_DEFINE(HAVE_GROUPCACHE, 1 , [Group Cache enabled]) fi AM_CONDITIONAL(HAVE_EMI, test x$need_emi = xyes) LIBS="-lfmt $LIBS" AC_LINK_IFELSE([AC_LANG_PROGRAM([#include ], [fmt::format("The answer is {}", 42); ])], [HAVE_FMT=1], [ CC=${CC} CXX=${CXX} sh ${ac_aux_dir}/tools/get_libfmt || exit 1 if test -d libfmt/include/fmt ; then CPPFLAGS="$CPPFLAGS -I$(pwd)/libfmt/include" else CPPFLAGS="$CPPFLAGS -I$(pwd)/libfmt" fi if test -f libfmt/libfmt.a ; then LDFLAGS="$LDFLAGS -L$(pwd)/libfmt" else LDFLAGS="$LDFLAGS -L$(pwd)/libfmt/fmt" fi AC_LINK_IFELSE([AC_LANG_PROGRAM([#include ], [fmt::format("The answer is {}", 42); ])], [], [AC_MSG_ERROR([libfmt just built is not usable!?!])]) ] ) AC_DEFINE(HAVE_FMT, 1, [ String formatting library installed. ]) AC_CHECK_HEADER([fmt/printf.h], AC_DEFINE(HAVE_FMT_PRINTF, 1, [ fmt/printf.h header found ]) ) if test -f /usr/include/libev/ev++.h ; then CPPFLAGS="$CPPFLAGS -I/usr/include/libev" fi AC_CHECK_LIB([ev], [ev_run],,[AC_MSG_ERROR([libev not found])]) EV_LIBS="-lev" AC_SUBST([EV_LIBS]) AM_CONDITIONAL(HAVE_SOURCE_INFO, test x$have_source_info = xyes ) AC_CHECK_PROGS(INDENT, indent, no) AC_CHECK_PROGS(JAR, fastjar jar, no) AC_CHECK_PROGS(JAVAC, "gcj -C" javac, no) AC_ARG_ENABLE(java, [ --enable-java build java client library], [case "${enableval}" in yes) enablejava=true ;; no) enablejava=false ;; *) AC_MSG_ERROR(bad value ${enableval} for --enable-java) ;; esac],[enablejava=false]) if test x$enablejava = xtrue ; then AC_DEFINE(BUILD_JAVA, 1 , [building java client library]) if test x"$JAVAC" = xno ; then AC_MSG_ERROR(no java compiler found) fi if test x"$JAR" = xno ; then AC_MSG_ERROR(jar not found) fi fi AM_CONDITIONAL(BUILD_JAVA, test x$enablejava = xtrue ) AC_CHECK_MEMBER([struct sockaddr_in.sin_len],[AC_DEFINE(HAVE_SOCKADDR_IN_LEN,1,[Do we have sockaddr_in.sin_len?])],[], [ #include #include #include ]) AC_CONFIG_HEADERS(config.h) AC_CONFIG_FILES([ Makefile src/Makefile src/common/Makefile src/backend/Makefile src/include/Makefile src/libserver/Makefile src/server/Makefile src/tools/Makefile src/usb/Makefile systemd/knxd-net.socket systemd/knxd.service systemd/knxd.socket systemd/Makefile src/client/Makefile src/client/c/Makefile src/client/cs/Makefile src/client/def/Makefile src/client/go/Makefile src/client/java/Makefile src/client/lua/Makefile src/client/pascal/Makefile src/client/perl/Makefile src/client/php/Makefile src/client/python/Makefile src/client/ruby/Makefile ]) dnl src/examples/Makefile dnl src/tools/eibnet/Makefile dnl src/tools/bcu/Makefile AC_OUTPUT AC_CONFIG_MACRO_DIR([m4]) knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/contrib/000077500000000000000000000000001476063574100216215ustar00rootroot00000000000000knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/contrib/udev/000077500000000000000000000000001476063574100225645ustar00rootroot00000000000000knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/contrib/udev/README.md000066400000000000000000000010111476063574100240340ustar00rootroot00000000000000udev rule file for KNX devices ============================== The common rules file for knxd is now located in debian/knxd.udev. See the head of that file for instructions if your device is not recognized, or if you have more than one hardware interface. Devices for KNX access will have access rights for user *knxd* which give the KNXd process (if started as user knxd) read and write access to the devices. It therefore does not to need to run as root. This is compatible with systemd files and the debian packages. knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/doc/000077500000000000000000000000001476063574100207265ustar00rootroot00000000000000knxd-0.14.73-00930870c6794c1d6d632f483dde042f8ede764c/doc/Doxyfile000066400000000000000000003232001476063574100224340ustar00rootroot00000000000000# Doxyfile 1.8.11 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. # # All text after a double hash (##) is considered a comment and is placed in # front of the TAG it is preceding. # # All text after a single hash (#) is considered a comment and will be ignored. # The format is: # TAG = value [value, ...] # For lists, items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file # that follow. The default is UTF-8 which is also the encoding used for all text # before the first occurrence of this tag. Doxygen uses libiconv (or the iconv # built into libc) for the transcoding. See http://www.gnu.org/software/libiconv # for the list of possible encodings. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded by # double-quotes, unless you are using Doxywizard) that should identify the # project for which the documentation is generated. This name is used in the # title of most generated pages and in a few other places. # The default value is: My Project. PROJECT_NAME = knxd # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version # control system is used. PROJECT_NUMBER = # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. PROJECT_LOGO = # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. OUTPUT_DIRECTORY = doc/api # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and # will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where # putting all generated files in the same directory would otherwise causes # performance problems for the file system. # The default value is: NO. CREATE_SUBDIRS = NO # If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII # characters to appear in the names of generated files. If set to NO, non-ASCII # characters will be escaped, for example _xE3_x81_x84 will be used for Unicode # U+3044. # The default value is: NO. ALLOW_UNICODE_NAMES = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, # Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), # Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, # Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), # Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, # Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, # Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, # Ukrainian and Vietnamese. # The default value is: English. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. # The default value is: YES. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator that is # used to form the text in various listings. Each string in this list, if found # as the leading text of the brief description, will be stripped from the text # and the result, after processing the whole list, is used as the annotated # text. Otherwise, the brief description is used as-is. If left blank, the # following values are used ($name is automatically replaced with the name of # the entity):The $name class, The $name widget, The $name file, is, provides, # specifies, contains, represents, a, an and the. ABBREVIATE_BRIEF = "The $name class" \ "The $name widget" \ "The $name file" \ is \ provides \ specifies \ contains \ represents \ a \ an \ the # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # doxygen will generate a detailed section even if there is only a brief # description. # The default value is: NO. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. # The default value is: NO. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path # before files name in the file list and in the header files. If set to NO the # shortest path that makes the file name unique will be used # The default value is: YES. FULL_PATH_NAMES = YES # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. # Stripping is only done if one of the specified strings matches the left-hand # part of the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the path to # strip. # # Note that you can specify absolute paths here, but also relative paths, which # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which # header file to include in order to use a class. If left blank only the name of # the header file containing the class definition is used. Otherwise one should # specify the list of include paths that are normally passed to the compiler # using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but # less readable) file names. This can be useful is your file systems doesn't # support long names like on DOS, Mac, or CD-ROM. # The default value is: NO. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the # first line (until the first dot) of a Javadoc-style comment as the brief # description. If set to NO, the Javadoc-style will behave just like regular Qt- # style comments (thus requiring an explicit @brief command for a brief # description.) # The default value is: NO. JAVADOC_AUTOBRIEF = NO # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first # line (until the first dot) of a Qt-style comment as the brief description. If # set to NO, the Qt-style will behave just like regular Qt-style comments (thus # requiring an explicit \brief command for a brief description.) # The default value is: NO. QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a # multi-line C++ special comment block (i.e. a block of //! or /// comments) as # a brief description. This used to be the default behavior. The new default is # to treat a multi-line C++ comment block as a detailed description. Set this # tag to YES if you prefer the old behavior instead. # # Note that setting this tag to YES also means that rational rose comments are # not recognized any more. # The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the # documentation from any documented member that it re-implements. # The default value is: YES. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new # page for each member. If set to NO, the documentation of a member will be part # of the file/class/namespace that contains it. # The default value is: NO. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen # uses this value to replace tabs by spaces in code fragments. # Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 4 # This tag can be used to specify a number of aliases that act as commands in # the documentation. An alias has the form: # name=value # For example adding # "sideeffect=@par Side Effects:\n" # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading # "Side Effects:". You can put \n's in the value part of an alias to insert # newlines. ALIASES = # This tag can be used to specify a number of word-keyword mappings (TCL only). # A mapping has the form "name=value". For example adding "class=itcl::class" # will allow you to use the command class in the itcl::class meaning. TCL_SUBST = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. For # instance, some of the names that are used will be different. The list of all # members will be omitted, etc. # The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or # Python sources only. Doxygen will then generate output that is more tailored # for that language. For instance, namespaces will be presented as packages, # qualified scopes will look different, etc. # The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources. Doxygen will then generate output that is tailored for Fortran. # The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for VHDL. # The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, Javascript, # C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: # FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: # Fortran. In the later case the parser tries to guess whether the code is fixed # or free formatted code, this is the default for Fortran type files), VHDL. For # instance to make doxygen treat .inc files as Fortran files (default is PHP), # and .f files as C (default is Fortran), use: inc=Fortran f=C. # # Note: For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. EXTENSION_MAPPING = # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable # documentation. See http://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. # The default value is: YES. MARKDOWN_SUPPORT = YES # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by putting a % sign in front of the word or # globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should set this # tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); # versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. # The default value is: NO. BUILTIN_STL_SUPPORT = NO # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. # The default value is: NO. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: # http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen # will parse them like normal C++ but will assume all classes use public instead # of private inheritance when no explicit protection keyword is present. # The default value is: NO. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate # getter and setter methods for a property. Setting this option to YES will make # doxygen to replace the get and set methods by a property in the documentation. # This will only work if the methods are indeed getting or setting a simple # type. If this is not the case, or you want to show the methods anyway, you # should set this option to NO. # The default value is: YES. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. # The default value is: NO. DISTRIBUTE_GROUP_DOC = NO # If one adds a struct or class to a group and this option is enabled, then also # any nested class or struct is added to the same group. By default this option # is disabled and one has to add nested compounds explicitly via \ingroup. # The default value is: NO. GROUP_NESTED_COMPOUNDS = NO # Set the SUBGROUPING tag to YES to allow class member groups of the same type # (for instance a group of public functions) to be put as a subgroup of that # type (e.g. under the Public Functions section). Set it to NO to prevent # subgrouping. Alternatively, this can be done per class using the # \nosubgrouping command. # The default value is: YES. SUBGROUPING = YES # When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions # are shown inside the group in which they are included (e.g. using \ingroup) # instead of on a separate page (for HTML and Man pages) or section (for LaTeX # and RTF). # # Note that this feature does not work in combination with # SEPARATE_MEMBER_PAGES. # The default value is: NO. INLINE_GROUPED_CLASSES = NO # When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions # with only public data fields or simple typedef fields will be shown inline in # the documentation of the scope in which they are defined (i.e. file, # namespace, or group documentation), provided this scope is documented. If set # to NO, structs, classes, and unions are shown on a separate page (for HTML and # Man pages) or section (for LaTeX and RTF). # The default value is: NO. INLINE_SIMPLE_STRUCTS = NO # When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or # enum is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically be # useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. # The default value is: NO. TYPEDEF_HIDES_STRUCT = NO # The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This # cache is used to resolve symbols given their name and scope. Since this can be # an expensive process and often the same symbol appears multiple times in the # code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small # doxygen will become slower. If the cache is too large, memory is wasted. The # cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range # is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 # symbols. At the end of a run doxygen will report the cache usage and suggest # the optimal cache size from a speed point of view. # Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. # Note: This will also disable the warnings about undocumented members that are # normally produced when WARNINGS is set to YES. # The default value is: NO. EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = NO # If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = NO # If the EXTRACT_STATIC tag is set to YES, all static members of a file will be # included in the documentation. # The default value is: NO. EXTRACT_STATIC = NO # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined # locally in source files will be included in the documentation. If set to NO, # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. If set to YES, local methods, # which are defined in the implementation section but not in the interface are # included in the documentation. If set to NO, only methods in the interface are # included. # The default value is: NO. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base name of # the file that contains the anonymous namespace. By default anonymous namespace # are hidden. # The default value is: NO. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all # undocumented members inside documented classes or files. If set to NO these # members will be included in the various overviews, but no documentation # section is generated. This option has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set # to NO, these classes will be included in the various overviews. This option # has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend # (class|struct|union) declarations. If set to NO, these declarations will be # included in the documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any # documentation blocks found inside the body of a function. If set to NO, these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation that is typed after a # \internal command is included. If the tag is set to NO then the documentation # will be excluded. Set it to YES to include the internal documentation. # The default value is: NO. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file # names in lower-case letters. If set to YES, upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. # The default value is: system dependent. CASE_SENSE_NAMES = NO # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with # their full class and namespace scopes in the documentation. If set to YES, the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO # If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will # append additional text to a page's title, such as Class Reference. If set to # YES the compound reference will be hidden. # The default value is: NO. HIDE_COMPOUND_REFERENCE= NO # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. SHOW_INCLUDE_FILES = YES # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each # grouped member an include statement to the documentation, telling the reader # which file to include in order to use the member. # The default value is: NO. SHOW_GROUPED_MEMB_INC = NO # If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include # files with double quotes in the documentation rather than with sharp brackets. # The default value is: NO. FORCE_LOCAL_INCLUDES = NO # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the # documentation for inline members. # The default value is: YES. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the # (detailed) documentation of file and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member # name. If set to NO, the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the # (brief and detailed) documentation of class members so that constructors and # destructors are listed first. If set to NO the constructors will appear in the # respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. # Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief # member documentation. # Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting # detailed member documentation. # The default value is: NO. SORT_MEMBERS_CTORS_1ST = NO # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy # of group names into alphabetical order. If set to NO the group names will # appear in their defined order. # The default value is: NO. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by # fully-qualified names, including namespaces. If set to NO, the class list will # be sorted only by class name, not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the alphabetical # list. # The default value is: NO. SORT_BY_SCOPE_NAME = NO # If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper # type resolution of all parameters of a function it will reject a match between # the prototype and the implementation of a member function even if there is # only one candidate or it is obvious which candidate to choose by doing a # simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still # accept a match between prototype and implementation in such cases. # The default value is: NO. STRICT_PROTO_MATCHING = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo # list. This list is created by putting \todo commands in the documentation. # The default value is: YES. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test # list. This list is created by putting \test commands in the documentation. # The default value is: YES. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional documentation # sections, marked by \if ... \endif and \cond # ... \endcond blocks. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the # initial value of a variable or macro / define can have for it to appear in the # documentation. If the initializer consists of more lines than specified here # it will be hidden. Use a value of 0 to hide initializers completely. The # appearance of the value of individual variables and macros / defines can be # controlled using \showinitializer or \hideinitializer command in the # documentation regardless of this setting. # Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at # the bottom of the documentation of classes and structs. If set to YES, the # list will mention the files that were used to generate the documentation. # The default value is: YES. SHOW_USED_FILES = YES # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This # will remove the Files entry from the Quick Index and from the Folder Tree View # (if specified). # The default value is: YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces # page. This will remove the Namespaces entry from the Quick Index and from the # Folder Tree View (if specified). # The default value is: YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command command input-file, where command is the value of the # FILE_VERSION_FILTER tag, and input-file is the name of an input file provided # by doxygen. Whatever the program writes to standard output is used as the file # version. For an example see the documentation. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed # by doxygen. The layout file controls the global structure of the generated # output files in an output format independent way. To create the layout file # that represents doxygen's defaults, run doxygen with the -l option. You can # optionally specify a file name after the option, if omitted DoxygenLayout.xml # will be used as the name of the layout file. # # Note that if you run doxygen from a directory containing a file called # DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE # tag is left empty. LAYOUT_FILE = # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool # to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the # search path. See also \cite for info how to create references. CITE_BIB_FILES = #--------------------------------------------------------------------------- # Configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated to # standard output by doxygen. If QUIET is set to YES this implies that the # messages are off. # The default value is: NO. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated to standard error (stderr) by doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. # The default value is: YES. WARNINGS = YES # If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: YES. WARN_IF_UNDOCUMENTED = YES # If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some parameters # in a documented function, or documenting parameters that don't exist or using # markup commands wrongly. # The default value is: YES. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return # value. If set to NO, doxygen will only warn about wrong or incomplete # parameter documentation, but not about the absence of documentation. # The default value is: NO. WARN_NO_PARAMDOC = NO # If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when # a warning is encountered. # The default value is: NO. WARN_AS_ERROR = NO # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which # will be replaced by the file and line number from which the warning originated # and the warning text. Optionally the format may contain $version, which will # be replaced by the version of the file (if it could be obtained via # FILE_VERSION_FILTER) # The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning and error # messages should be written. If left blank the output is written to standard # error (stderr). WARN_LOGFILE = #--------------------------------------------------------------------------- # Configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag is used to specify the files and/or directories that contain # documented source files. You may enter file names like myfile.cpp or # directories like /usr/src/myproject. Separate the files or directories with # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. INPUT = src/common \ src/include \ src/libserver \ src/server \ src/usb # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv # documentation (see: http://www.gnu.org/software/libiconv) for the list of # possible encodings. # The default value is: UTF-8. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and # *.h) to filter out the source-files in the directories. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # read by doxygen. # # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, # *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. FILE_PATTERNS = *.c \ *.cc \ *.cxx \ *.cpp \ *.c++ \ *.java \ *.ii \ *.ixx \ *.ipp \ *.i++ \ *.inl \ *.idl \ *.ddl \ *.odl \ *.h \ *.hh \ *.hxx \ *.hpp \ *.h++ \ *.cs \ *.d \ *.php \ *.php4 \ *.php5 \ *.phtml \ *.inc \ *.m \ *.markdown \ *.md \ *.mm \ *.dox \ *.py \ *.pyw \ *.f90 \ *.f \ *.for \ *.tcl \ *.vhd \ *.vhdl \ *.ucf \ *.qsf \ *.as \ *.js # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. # The default value is: NO. RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that should be # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. # # Note that relative paths are relative to the directory from which doxygen is # run. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded # from the input. # The default value is: NO. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test # # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include # command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and # *.h) to filter out the source-files in the directories. If left blank all # files are included. EXAMPLE_PATTERNS = * # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude commands # irrespective of the value of the RECURSIVE tag. # The default value is: NO. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or directories # that contain images that are to be included in the documentation (see the # \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command: # # # # where is the value of the INPUT_FILTER tag, and is the # name of an input file. Doxygen will then use the output that the filter # program writes to standard output. If FILTER_PATTERNS is specified, this tag # will be ignored. # # Note that the filter must not add or remove lines; it is applied before the # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. Doxygen will compare the file name with each pattern and apply the # filter if there is a match. The filters are a list of the form: pattern=filter # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how # filters are used. If the FILTER_PATTERNS tag is empty or if none of the # patterns match the file name, INPUT_FILTER is applied. # # Note that for custom extensions or not directly supported extensions you also # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will also be used to filter the input files that are used for # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. FILTER_SOURCE_FILES = NO # The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file # pattern. A pattern will override the setting for FILTER_PATTERN (if any) and # it is also possible to disable source filtering for a specific pattern using # *.ext= (so without naming a filter). # This tag requires that the tag FILTER_SOURCE_FILES is set to YES. FILTER_SOURCE_PATTERNS = # If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that # is part of the input, its contents will be placed on the main page # (index.html). This can be useful if you have a project on for instance GitHub # and want to reuse the introduction page also for the doxygen output. USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- # Configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will be # generated. Documented entities will be cross-referenced with these sources. # # Note: To get rid of all source code in the generated output, make sure that # also VERBATIM_HEADERS is set to NO. # The default value is: NO. SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body of functions, # classes and enums directly into the documentation. # The default value is: NO. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any # special comment blocks from generated source code fragments. Normal C, C++ and # Fortran comments will always remain visible. # The default value is: YES. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES then for each documented # function all documented functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES then for each documented function # all documented entities called/used by that function will be listed. # The default value is: NO. REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set # to YES then the hyperlinks from functions in REFERENCES_RELATION and # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will # link to the documentation. # The default value is: YES. REFERENCES_LINK_SOURCE = YES # If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the # source code will show a tooltip with additional information such as prototype, # brief description and links to the definition and documentation. Since this # will make the HTML file larger and loading of large files a bit slower, you # can opt to disable this feature. # The default value is: YES. # This tag requires that the tag SOURCE_BROWSER is set to YES. SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system # (see http://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. # # To use it do the following: # - Install the latest version of global # - Enable SOURCE_BROWSER and USE_HTAGS in the config file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # # Doxygen will invoke htags (and that will in turn invoke gtags), so these # tools must be available from the command line (i.e. in the search path). # # The result: instead of the source browser generated by doxygen, the links to # source code will now point to the output of htags. # The default value is: NO. # This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a # verbatim copy of the header file for each class for which an include is # specified. Set to NO to disable this. # See also: Section \class. # The default value is: YES. VERBATIM_HEADERS = YES # If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the # clang parser (see: http://clang.llvm.org/) for more accurate parsing at the # cost of reduced performance. This can be particularly helpful with template # rich C++ code for which doxygen's built-in parser lacks the necessary type # information. # Note: The availability of this option depends on whether or not doxygen was # generated with the -Duse-libclang=ON option for CMake. # The default value is: NO. CLANG_ASSISTED_PARSING = NO # If clang assisted parsing is enabled you can provide the compiler with command # line options that you would normally use when invoking the compiler. Note that # the include paths will already be set by doxygen for the files and directories # specified with INPUT and INCLUDE_PATH. # This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. CLANG_OPTIONS = #--------------------------------------------------------------------------- # Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all # compounds will be generated. Enable this if the project contains a lot of # classes, structs, unions or interfaces. # The default value is: YES. ALPHABETICAL_INDEX = YES # The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in # which the alphabetical index list will be split. # Minimum value: 1, maximum value: 20, default value: 5. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored # while generating the index headers. # This tag requires that the tag ALPHABETICAL_INDEX is set to YES. IGNORE_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of # it. # The default directory is: html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for each # generated HTML page (for example: .htm, .php, .asp). # The default value is: .html. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a user-defined HTML header file for # each generated HTML page. If the tag is left blank doxygen will generate a # standard header. # # To get valid HTML the header file that includes any scripts and style sheets # that doxygen needs, which is dependent on the configuration options used (e.g. # the setting GENERATE_TREEVIEW). It is highly recommended to start with a # default header using # doxygen -w html new_header.html new_footer.html new_stylesheet.css # YourConfigFile # and then modify the file new_header.html. See also section "Doxygen usage" # for information on how to generate the default header that doxygen normally # uses. # Note: The header is subject to change so you typically have to regenerate the # default header when upgrading to a newer version of doxygen. For a description # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard # footer. See HTML_HEADER for more information on how to generate a default # footer and what special commands can be used inside the footer. See also # section "Doxygen usage" for information on how to generate the default footer # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_FOOTER = # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of # the HTML output. If left blank doxygen will generate a default style sheet. # See also section "Doxygen usage" for information on how to generate the style # sheet that doxygen normally uses. # Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as # it is more robust and this tag (HTML_STYLESHEET) will in the future become # obsolete. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_STYLESHEET = # The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined # cascading style sheets that are included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the # standard style sheet and is therefore more robust against future updates. # Doxygen will copy the style sheet files to the output directory. # Note: The order of the extra style sheet files is of importance (e.g. the last # style sheet in the list overrules the setting of the previous ones in the # list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note # that these files will be copied to the base HTML output directory. Use the # $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these # files. In the HTML_STYLESHEET file, use the file name only. Also note that the # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen # will adjust the colors in the style sheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see # http://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 # The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors # in the HTML output. For a value of 0 the output will use grayscales only. A # value of 255 will produce the most vivid colors. # Minimum value: 0, maximum value: 255, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 100 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the # luminance component of the colors in the HTML output. Values below 100 # gradually make the output lighter, whereas values above 100 make the output # darker. The value divided by 100 is the actual gamma applied, so 80 represents # a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not # change the gamma. # Minimum value: 40, maximum value: 240, default value: 80. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting this # to YES can help to show when doxygen was last run and thus if the # documentation is up to date. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = YES # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = NO # With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries # shown in the various tree structured indices initially; the user can expand # and collapse entries dynamically later on. Doxygen will expand the tree to # such a level that at most the specified number of entries are visible (unless # a fully collapsed tree already exceeds this amount). So setting the number of # entries 1 will produce a full collapsed tree by default. 0 is a special value # representing an infinite number of entries and will result in a full expanded # tree by default. # Minimum value: 0, maximum value: 9999, default value: 100. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development # environment (see: http://developer.apple.com/tools/xcode/), introduced with # OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a # Makefile in the HTML output directory. Running make will produce the docset in # that directory and running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at # startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html # for more information. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO # This tag determines the name of the docset feed. A documentation feed provides # an umbrella under which multiple documentation sets from a single provider # (such as a company or product suite) can be grouped. # The default value is: Doxygen generated docs. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" # This tag specifies a string that should uniquely identify the documentation # set bundle. This should be a reverse domain-name style string, e.g. # com.mycompany.MyDocSet. Doxygen will append .docset to the name. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project # The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify # the documentation publisher. This should be a reverse domain-name style # string, e.g. com.mycompany.MyDocSet.documentation. # The default value is: org.doxygen.Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher # The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. # The default value is: Publisher. # This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop # (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on # Windows. # # The HTML Help Workshop contains a compiler that can convert all HTML output # generated by doxygen into a single compiled HTML file (.chm). Compiled HTML # files are now used as the Windows 98 help format, and will replace the old # Windows help format (.hlp) on all Windows platforms in the future. Compressed # HTML files also contain an index, a table of contents, and you can search for # words in the documentation. The HTML workshop also contains a viewer for # compressed HTML files. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO # The CHM_FILE tag can be used to specify the file name of the resulting .chm # file. You can add a path in front of the file if the result should not be # written to the html output directory. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path # including file name) of the HTML help compiler (hhc.exe). If non-empty, # doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = # The GENERATE_CHI flag controls if a separate .chi index file is generated # (YES) or that it should be included in the master .chm file (NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO # The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = # The BINARY_TOC flag controls whether a binary table of contents is generated # (YES) or a normal table of contents (NO) in the .chm file. Furthermore it # enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members to # the table of contents of the HTML help documentation and to the tree view. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and # QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that # can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help # (.qch) of the generated HTML documentation. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify # the file name of the resulting .qch file. The path specified is relative to # the HTML output folder. # This tag requires that the tag GENERATE_QHP is set to YES. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace # (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = org.doxygen.Project # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual # Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- # folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom # Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: # http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = # The QHG_LOCATION tag can be used to specify the location of Qt's # qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the # generated .qhp file. # This tag requires that the tag GENERATE_QHP is set to YES. QHG_LOCATION = # If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be # generated, together with the HTML files, they form an Eclipse help plugin. To # install this plugin and make it available under the help contents menu in # Eclipse, the contents of the directory containing the HTML and XML files needs # to be copied into the plugins directory of eclipse. The name of the directory # within the plugins directory should be the same as the ECLIPSE_DOC_ID value. # After copying Eclipse needs to be restarted before the help appears. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO # A unique identifier for the Eclipse help plugin. When installing the plugin # the directory name containing the HTML and XML files should also have this # name. Each documentation set should have its own identifier. # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project # If you want full control over the layout of the generated HTML pages it might # be necessary to disable the index and replace it with your own. The # DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top # of each HTML page. A value of NO enables the index and the value YES disables # it. Since the tabs in the index contain the same information as the navigation # tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. If the tag # value is set to YES, a side panel will be generated containing a tree-like # index structure (just like the one that is generated for HTML Help). For this # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the # HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can # further fine-tune the look of the index. As an example, the default style # sheet generated by doxygen has an example that shows how to put an image at # the root of the tree instead of the PROJECT_NAME. Since the tree basically has # the same information as the tab index, you could consider setting # DISABLE_INDEX to YES when enabling this option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = YES # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that # doxygen will group on one line in the generated HTML documentation. # # Note that a value of 0 will completely suppress the enum values from appearing # in the overview section. # Minimum value: 0, maximum value: 20, default value: 4. # This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 4 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used # to set the initial width (in pixels) of the frame in which the tree is shown. # Minimum value: 0, maximum value: 1500, default value: 250. # This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 # If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO # Use this tag to change the font size of LaTeX formulas included as images in # the HTML documentation. When you change the font size after a successful # doxygen run you need to manually remove any form_*.png images from the HTML # output directory to force them to be regenerated. # Minimum value: 8, maximum value: 50, default value: 10. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 # Use the FORMULA_TRANPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # # Note that when changing this option you need to delete any form_*.png files in # the HTML output directory before the changes have effect. # The default value is: YES. # This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see # http://www.mathjax.org) which uses client side Javascript for the rendering # instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path # to it using the MATHJAX_RELPATH option. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO # When MathJax is enabled you can set the default output format to be used for # the MathJax output. See the MathJax site (see: # http://docs.mathjax.org/en/latest/output.html) for more details. # Possible values are: HTML-CSS (which is slower, but has the best # compatibility), NativeMML (i.e. MathML) and SVG. # The default value is: HTML-CSS. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_FORMAT = HTML-CSS # When MathJax is enabled you need to specify the location relative to the HTML # output directory using the MATHJAX_RELPATH option. The destination directory # should contain the MathJax.js script. For instance, if the mathjax directory # is located at the same level as the HTML output directory, then # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of # MathJax from http://www.mathjax.org before deployment. # The default value is: http://cdn.mathjax.org/mathjax/latest. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest # The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax # extension names that should be enabled during MathJax rendering. For example # MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_EXTENSIONS = # The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces # of code that will be used on startup of the MathJax code. See the MathJax site # (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an # example see the documentation. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_CODEFILE = # When the SEARCHENGINE tag is enabled doxygen will generate a search box for # the HTML output. The underlying search engine uses javascript and DHTML and # should work on any modern browser. Note that when using HTML help # (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) # there is already a search function so this one should typically be disabled. # For large projects the javascript based search engine can be slow, then # enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to # search using the keyboard; to jump to the search box use + S # (what the is depends on the OS and browser, but it is typically # , /