pax_global_header00006660000000000000000000000064151057351530014517gustar00rootroot0000000000000052 comment=8660f29c0370ca093d45ea6c91277edd00d51301 rockowitz-ddcutil-7a384a9/000077500000000000000000000000001510573515300155425ustar00rootroot00000000000000rockowitz-ddcutil-7a384a9/.github/000077500000000000000000000000001510573515300171025ustar00rootroot00000000000000rockowitz-ddcutil-7a384a9/.github/workflows/000077500000000000000000000000001510573515300211375ustar00rootroot00000000000000rockowitz-ddcutil-7a384a9/.github/workflows/codeql.yml000066400000000000000000000105031510573515300231300ustar00rootroot00000000000000# For most projects, this workflow file will not need changing; you simply need # to commit it to your repository. # # You may wish to alter this file to override the set of languages analyzed, # or to provide custom queries or build logic. # # ******** NOTE ******** # We have attempted to detect the languages in your repository. Please check # the `language` matrix defined below to confirm you have the correct set of # supported CodeQL languages. # name: "CodeQL Advanced" on: push: branches: [ "2.2.0-dev" ] pull_request: branches: [ "2.2.0-dev" ] schedule: - cron: '33 13 * * 6' jobs: analyze: name: Analyze (${{ matrix.language }}) # Runner size impacts CodeQL analysis time. To learn more, please see: # - https://gh.io/recommended-hardware-resources-for-running-codeql # - https://gh.io/supported-runners-and-hardware-resources # - https://gh.io/using-larger-runners (GitHub.com only) # Consider using larger runners or machines with greater resources for possible analysis time improvements. runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }} permissions: # required for all workflows security-events: write # required to fetch internal or private CodeQL packs packages: read # only required for workflows in private repositories actions: read contents: read strategy: fail-fast: false matrix: include: - language: c-cpp build-mode: autobuild # CodeQL supports the following values keywords for 'language': 'c-cpp', 'csharp', 'go', 'java-kotlin', 'javascript-typescript', 'python', 'ruby', 'swift' # Use `c-cpp` to analyze code written in C, C++ or both # Use 'java-kotlin' to analyze code written in Java, Kotlin or both # Use 'javascript-typescript' to analyze code written in JavaScript, TypeScript or both # To learn more about changing the languages that are analyzed or customizing the build mode for your analysis, # see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning. # If you are analyzing a compiled language, you can modify the 'build-mode' for that language to customize how # your codebase is analyzed, see https://docs.github.com/en/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/codeql-code-scanning-for-compiled-languages steps: - name: Checkout repository uses: actions/checkout@v4 # Initializes the CodeQL tools for scanning. - name: Initialize CodeQL uses: github/codeql-action/init@v3 with: languages: ${{ matrix.language }} build-mode: ${{ matrix.build-mode }} # If you wish to specify custom queries, you can do so here or in a config file. # By default, queries listed here will override any specified in a config file. # Prefix the list here with "+" to use these queries and those in the config file. # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs # queries: security-extended,security-and-quality # If the analyze step fails for one of the languages you are analyzing with # "We were unable to automatically build your code", modify the matrix above # to set the build mode to "manual" for that language. Then modify this step # to build your code. # ℹī¸ Command-line programs to run using the OS shell. # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun - if: matrix.build-mode == 'manual' shell: bash run: | echo 'If you are using a "manual" build mode for one or more of the' \ 'languages you are analyzing, replace this with the commands to build' \ 'your code, for example:' echo ' make bootstrap' echo ' make release' aclocal autoheader autoconf automake ./configure make exit 1 - name: Perform CodeQL Analysis uses: github/codeql-action/analyze@v3 with: category: "/language:${{matrix.language}}" rockowitz-ddcutil-7a384a9/.gitignore000066400000000000000000000013631510573515300175350ustar00rootroot00000000000000.gitignore # Editor temporary files *~ *.swp # Other temporary files *.tmp # Extensions *.o *.lo *.la *.expand *.pyc # Hidden directories .deps .dirstamp .libs # Hidden files .clang-format # Autotools aclocal.m4 autom4te.cache config.cache /config.h /config.h.in /stamp-h1 /config.log /config.site /config.status /configure /libtool Makefile Makefile.in /autoscan.log /configure.scan src/**/am--include-marker src/base/build_details.h # Generated files ddcutil.pc src/public/ddcutil_macros.h docs/ddcutil-c-api # Executable /src/ddcutil # Experimental API implementations *.typelib *.gir # Eclipse .settings/ .autotools .cproject .project # Doxygen output doxydoc/html doxydoc/latex doxydoc/apidoc # Miscellaneous tools /heaptrack* *.tar.gz rockowitz-ddcutil-7a384a9/AUTHORS000066400000000000000000000000521510573515300166070ustar00rootroot00000000000000Sanford Rockowitz rockowitz-ddcutil-7a384a9/CHANGELOG.md000066400000000000000000001537701510573515300173700ustar00rootroot00000000000000## [2.2.2] 2025-11-13 ### General #### Added - Option ***--trcback***: report call stack that led to specified function (initial implementation). Requires ***--enable-traced-function-stack***. - Option ***--trace-to_syslog***: Direct trace output to the system log, without disabling other destinations. #### Changed - Option ***--enable-traced-function-stack*** is now the default. - Additional messages reporting configuration file errors. In particular, section names and the names of keys within each section are validated. Section names other than [global], [ddcutil], and [libddcutil] are flagged as errors. - If possible, obtain list of PNP ids from /usr/share/hwdata/pnp.ids instead of using hardcoded list. - Reword the parser explanation of options ***--verify*** and ***--noverify*** for clarity. #### Fixed - Command **setvcp --verify** and API function **ddca_set_non_table_vcp_value()**: were not performing verification, - Command **getvcp --verbose**: output was partially in a format intended for syslog - **ddca_display_ref_from_handle()**: was not converting internal to external display reference, causing a segfault. Issue #528. - Relax the check of the device class when determining if a device is a video controller. Look only at the first byte in sysfs device attribute class. An AMD Ryzen AI 9 365 based system was seen to report 0x038000, not 0x030000. Addresses issue #530. - Build failed with an undefined reference error when configure option ***--disable-drm*** was specified. API function **ddca_redetect_displays()** now returns DDCRC_INVALID_OPERATION if ddcutil was built with ***--disable-drm***. (An alternative code path through **ddca_redetect_displays()** is possible for the ***--disable-drm*** case, but is non-trivial and so not implemented for now.) Also option ***--disable-drm*** forces ***--disable-watch-displays***. Addresses issue #506 - man page ddcutil: correct typo in hyperlink. Patch #535 - man page ddcutil: document that **loadvcp** uses the display identifier on the command line if one was specified, and ensures it identifies the same display as the one identified by the data in the file being loaded. Noted in issue #552. - Command **environment --verbose**: - Permission denied errors corrupted output of the find command used to scan for DisplayLink devices. - Incorrectly formed path name for examining /sys/class/drm - Fix invalid hyperlink in README.md. Pull Request #558 #### Building - Fix out-of-tree build reference to generated file /src/base/build_details.h. Pull request #544 ### Shared library The shared library **libddcutil** is backwardly compatible with the one in ddcutil 2.2.1. The SONAME is unchanged as libddcutil.so.5. The released library file is libddcutil.so.5.4.0. #### Added - Option ***--watch-mode udev*** Uses libudev to watch for display connection and disconnection. This is now the default watch mode when executing on wayland if ddcutil was built to use libudev, which is normally the case (configure option ***--enable-udev***). Xevent continues to be the default watch mode when executing on X11. A specific watch mode can be forced using ***--watch-mode udev***, ***--watch-mode xevent***, or ***--watch-mode poll***. Addresses issues in [KDE-Plasma Powerdevil merge request 542] (https://invent.kde.org/plasma/powerdevil/-/merge_requests/542) - Define bit **DDCA_NOVERIFY** in **DDCA_Version_Feature_Flags**. #### Fixed - **ddca_open_display2()**: Return DDCRC_INTERNAL_ERROR instead of terminating with assert() failure in certain ill-defined situations. Addresses issue #556 reported by PowerDevil. - **ddca_redetect_displays()**: Set the **DREF_REMOVED** bit in all entries in the table of published display references, i.e. references that have been reported to the client program, instead of emptying the table. ## [2.2.1] 2025-07-07 ### General #### Added - Do not perform permission checks if running with effective user root, i.e. when running with setuid bit set. Partially addresses issue #509 #### Changed - Command **environment**: report if running as root, with sudo, or setuid bit set - Command **environment --verbose**: eliminate some unneeded edid read tests - Command **setvcp**: Emit more more useful messages when the cause of a DDCRC_RETRIES error is itself a DDCRC_RETRIES error. - Add option ***--disable-traced-function-stack*** The default traced-function-stack option value (disabled) is set in parms.h. #### Fixed - Avoid segfault if invalid feature code specified - Maximum wait time on function lock_display() not respected, possible infinte loop. Addresses issue #511 - Fix --verify/--noverify parsing. Addresses issue #512. - ddca_close_display(): do not respect quiesce, allowing the display lock record to be released, avoiding possible deadlock - Fix the spelling of company name HON HAI PRECISION" (obtained from UEFI), avoiding a lintian message. Addresses issue #500 - Fix errors reported by clang 19: unused variable, expression which evaluates to 0 treated as null pointer. Addresses issue #502. - Command **getvcp --terse**: Eliminate irrelevant messages regarding VCP version not set. - Make test for missing DRM card-connector directories more robust. Issue #507. - DDC communication not detected with old (340 series) Nvidia proprietary driver. Issue #507 - Function end_capture(): call close() in case of fflush() error, ensuring that messages are always sent to the terminal after message capture complete - Functions **ddca_find_display_ref()** and **ddca_get_display_ref()** were returning a pointer to the internal Display_Ref struct rather than an external integer DDCA_Display_Ref, causing segfault or return code DDCRC_INVALID_DISPLAY on a subsequent api call such as **ddca_open_display2()**. Addresses issue #528. - Several API functions were not recognized as arguments to ***--trcfunc*** and ***--trcfrom***. These included **ddca_find_display_ref()**, **ddca_get_display_ref()**, **report_parsed_capabilities()** - Option ***--stats*** was not reporting data - **ddc_open_display()**: return DDCRC_DISCONNECTED instead of an assert failure if bus_info == NULL. Addresses KDE Powerdevil issue #504861 (powerdevil crash from libddcutil, no restart happens) - Macro TRACED_ASSERT() calls **__assert_fail()** instead of exit(1). Addresses Powerdevil issue #504861. - Fix troff formatting in ddcutil man page. Pull request #531. ### Building - **configure** option ***--enable-watch-displays***/***--disable-watch-displays*** controls whether display watch functionaliity is built. The default is ***--enable-watch-displays***. - If built with ***--disable-watch-displays***, API functions related to display change detection return DDCRC_UNIMPLEMENTED - If **configure** option ***--disable-x11*** is specified, the only watch-mode is POLL. watch-mode XEVENT does not exist. #### Shared Library ### Added - Struct DDCA_Display_Info2 is an extended version of DDCA_Display_Info that adds fields for the display's sysfs card-connector directory, how that directory was determined (precisely using I2C bus number or heristically using EDID), and the DRM connector id. API functions have been added to use this struct: **ddca_get_display_info2()**, **ddca_free_display_info2()**, and **ddca_report_display_info2()**. Addresses issue #518. ### Changed - By default, watching for display connection and disconnection by default uses watch-mode **XEVENT** if X11 is the display manager, watch-mode **UDEV** otherwise. - Callback function handling made more bulletproof - Close any unlock displays left open by user callback function - Write syslog messages (with log level NOTICE) before and after executing the callback function ### Fixed - **ddca_redetect_displays()**: block if called with callback threads active or if already executing - **ddca_close_display()**: allow execution even if libddcutil is quiesced. Avoids a possible deadlock due to an internal display lock not being released. - **ddca_stop_watch_displays()** did not release the X11/Wayland connection obtained by **ddca_start_watch_displays()**. This also occured with each **ddca_redetect_displays()** call. As a result KDE PowerDevil eventually exhausted X11 connections of a very long running system with repeated display connections and disconnections. Pull request #519. - KDE powerdevil was terminating with status success instead of failure if libddcutil terminated with a traced assertion, causing the powerdevil service to not restart automatically. Macro TRACE_ASSERT() is modified to use **__assert_fail()** instead of **exit()** for termination. ## [2.2.0] 2025-02-10 ### General #### Added - Support DisplayLink devices - Add command **noop**, which allows for executing options such as ***--settings*** without having to execute a real command. - As an aid to development, the build date and time are normally embedded in the ddcutil and libddcutil executables. This is reported using command **ddcutil --version --verbose". **libddcutil** reports this to the system log. If reproducible builds are required, use **configure** option ***--disable-build-timestamp***. (For reproducible builds, building typically is performed using a script or build system, so it's not inconvenient to specify ***--disable-build-timestamp*** in this situation.) - Add ***--enable-flock*** and ***--disable-flock*** as aliases for ***--enable-cross-instance-locks*** and ***--disable-cross-instance-locks*** - Add option ***--ignore-mmid*** to ignore problematic monitor models. Takes a Monitor Model Id, e.g. SAM-U32H75x-3587 as an argument. Indicates that DDC/CI communication is disabled for monitors with this id. Typically, this will be added to the [libddcutil] section of configuration file ddcutilrc. It can also be included in the options string passed in the opts argument to ddca_init2(). Addresses issue #446. - Maintain a stack of traced functions for debugging. Turned on by option ***--enable-traced-function-stack*** #### Changed - User Defined Features: - Add XNC (Extended Non-Continous) like simple NC, but the SH byte is also reported. - Allow SNC (Simple Non-Continuous) as alternative name for NC. - Report user defined features as part of parsed capabilities. - Commands recognizing user defined features now fail if there's an error loading a user defined feature file. These are **capabilities**, **setvcp**, **dumpvcp**, and **probe**. - /usr/lib/udev/rules.d/60-ddcutil-i2c-rules: - Give logged on user r/w access to /dev/dri/cardN, needed to allow logged on user to probe connectors using DRM. - Do not install /usr/lib/udev/rules.d/60-ddcutil-usb.rules, delete it if previously installed. Addresses issues #405, #428, #437 - Command **ddcutil chkusbmon**: - Skip processing and always return 1 (failure) if option ***--disable-usb*** is in effect. - Command **detect**: - Only show communication error detail if --verbose - Provide a clearer message if slave address x37 is inactive: - "Monitor does not support DDC" instead of generic "DDC_commnication failed" - If option ***--verbose*** is in effect, emit an additional message to check the monitor's OSD. - Parser changes: - Add alternative option names for symmetry with other options: - ***--discard-capabilities-cache*** is an alias for ***--discard-cache capabilities*** - ***--discard-sleep-cache*** is an alias for ***--discard cache dsa*** - ***--discard-dsa-cache*** is an alias for ***--discard cache dsa*** - Eliminate --enable-dsa-cache as alias for --enable-dynamic-sleep-cache - Improve handling of --verify/--noverify, error if both specified - File .gitignore: - Add: *.tar.gz, docs/ddcutil-c-api - Commands **interrogate** and **environment --verbose**: - Force settings --disable-cross-instance-locking, --disable-dynamic-sleep (VERIFY) - Forced settings apply to **environment --verbose** as well as **interrogate** - When probing DRM, recognize bus types DRM_BUS_PLATFORM, DRM_BUS_HOST1X, report as "platform", "host1x" - Change the system log message level when sleep time is adjusted from WARNING to VERBOSE. Addresses issue #427: Adjusting multiplier message fills system log when libddcutil used by clightd - Configuration file ddcutilrc: If there is a pound sign "#" on a line, the remainder of the line is treated as a comment. - Add -Wformat-security to compiler options. Addresses issue #458. - If option --bus specified, only check accessability for that bus, avoiding irrelevant warning messages regarding other buses. Addresses issue #461. - Return DDCRC_CONFIG_ERROR instead of DDCRC_BAD_DATA for User Defined Feature File errors. - Report the Monitor Model Id in the ***--verbose*** output to **ddcutil detect**. - Command **setvcp**: Do not report "Interpretation may not be accurate.", which is irrelevant for this command. Partially addresses issue #454. - rpt...() functions can redirect output to syslog, making lines coming from multiple threads more coherent - Enable additional compiler warnings to tighten the code. - Additional trace groups SYSFS, CONN #### Fixed - Rework laptop detection. A non-laptop display can have an eDP connector. This is an i915 video driver bug that will not be fixed. See freedesktop.org issue "DRM connector for external monitor has name card1-eDP-1" https://gitlab.freedesktop.org/drm/i915/kernel/-/issues/10389 - When processing environment variable user $XDG_DATA_DIRS, or $XDG_CONFIG_DIRS, the final directory in the list was ignored. Issue #438 - When processing a user defined feature file, recognize any whitespace character (e.g. tab), not just space. - Fix core dump on ddcutil getvcp. Issue #407 - Commands **interrogate** and **environment --verbose** - Simple getvcp test was not reporting the bytes of the response packet. - If no device with class x03 was found, the user's home directory was dumped. Issue #413. - Remove "-i" option on get-edid command. Does not exist on some versions. - Fix display not found on Raspberry Pi. Do not rely on /sys/class/drm to read EDID, which is not valid for some drivers. Addresses issue #403 - Fix DDC communication failed on Raspberry Pi. Do not rely on sysfs attributes that do not exist for ARM devices. Resolves issue #413. - User Define Features file: fix error msg when nothing follow VALUE - Convert CRLF line endings to LF - Use printf() formats %jd and %zd to portably print variables of type ssize_t, time_t, so as to build unchanged on architectures such as armel, armhf. - Avoid compiler warning possible depending on compiler configuration when a switch() construct is used. Replaced with if/else if/else. Resolves issue #458. - Do not use function strerrrorname_np(). Requires glibc >= 2.32. - Miscellaneous changes to allow for building on raspbian (debian bullseye). - Replace function sysfs_find_adapter(). Fixes display detection problem aspect of issue #465. - Dump information to syslog instead of asserting failure if unable to get flock on /dev/i2c device. - Option ***--skip-ddc-checks*** set vcp version in Display_Ref to DDCA_VSPEC_UNKNOWN to avoid possible assert failure. - Prepend thread id to most syslog messages. - Make syslog messages more consistent in form. - Memory leaks. ### Building - Re-enable autoconf/configure option --enable-x11/--disable-x11. X11 specific code is used in display change and sleep state detection. The default is --enable-x11. - Add autoconf/configure option ***--enable-static-functions-visible***. If set, storage class specifier "static" is removed from many functions so that their names appear in backtrace reports from valgrind, asan, and glibc function backtrace(). ### Shared Library The shared library **libddcutil** is backwardly compatible with the one in ddcutil 2.1.x. The SONAME is unchanged as libddcutil.so.5. The released library file is libddcutil.so.5.2.0. #### Added - Option ***--disable-api*** completely disables the API. Most API calls, including those performing DDC communications, will fail. This can be useful for testing whether **libddcutil** is the source of a system error in the case of client applications, e.g. KDE PowerDevil, that will not build without the shared library. - Add libddcutil only option ***--disable-watch-displays***, which unconditionally blocks **ddca_start_watch_displays()** from starting the thread that watches for display changes. Workaround for issue #470. - **ddca_get_display_watch_settings()**, **ddca_set_display_watch_settings()** #### Changed - **ddca_start_watch_displays()**: - The only event class that can currently be enabled is DDCA_EVENT_CLASS_DISPLAY_CONNECTION. Watching for sleep state changes is not currently supported. - Regards DDCA_EVENT_CLASS_ALL as same as DDCA_EVENT_CLASS_DISPLAY_CONNECTION - Error if either DDCA_EVENT_CLASS_DPMS or DDCA_EVENT_CLASS_NONE are specified. - Status code DDCRC_INVALID_CONFIG_FILE renamed to more general DDCRC_CONFIG_ERROR. DDCRC_INVALID_CONFIG_FILE is a valid alias. - Write build date and time to system log when starting libddcutil. - Rework libdccutil output to avoid duplicate msgs in system log when all terminal output is directed to the log, as with KDE Plasma - Most API functions that specify a display reference now return status code DDCRC_DISCONNECTED if the display reference is no longer valid. - Quiesce the API during **ddca_redetect_displays()**. Operations that access display state are not permitted, and return DDCRC_QUIESCED. - Add DDCA_STATS_API to enum DDCA_Stats_Type, for reporting API specific stats. - Compile using option -Wformat-security. Issue #458. - Opaque pointer DDCA_Display_Ref now contains a display reference id instead of an actual pointer. It's type continues to be void* so client program use of this type is unchanged. - **libddcutil** maintains a table of DDCA_Display_Refs that have been "published" by the API, for validating DDCA_Display_Ref args on API function calls. - The opaque value in DDCA_Display_Ref is now an integer id number instead of pointer into the libddcutil data structures, making it slightly more opaque. The type of DDCA_Display_Ref remains "void*", so no client changes are needed - syslog output is generally prefixed with date and thread id #### Fixed - Whan a display is connected, the display number assigned to its display reference is one greater than the highest already assigned, instead of 99. - **ddca_start_watch_displays()**: Fixed segfault that occured with driver nvidia when checking if all video adapters implement drm. Issue #390. - Ignore phantom displays when searching for a display reference. Issue #412. - **ddca_get_display_refs()**, **ddca_get_display_info_list2()** always return 0, even if an error occured when examining a particular monitor. Addresses issue #417. - Errors that occur opening individual displays or reading their EDIDs are are still reported using **ddca_get_error_detail()**. In addition, error messages are written to the terminal and, depending on the current syslog level, to the system log. - **ddca_get_display_refs()** and **ddac_get_display_info_list2()** do not include display references for displays that are no longer connected. - **ddca_get_display_info()** succeeds even if DDC communication is not working. Addresses issue #???. - Display reference validation: Do not use dref->drm_connector, which may be invalid after hotplug. Addresses issue #418. - **ddca_dref_repr()**: Do not check that the display reference is still valid. It is meaningful to create a string representation of a display reference even if it is no longer usable. Addresses ddcui issue #55. - Protect hash table of open monitors to avoid a possible race condition. - Recover instead of abort when more than one non-removed display refs exist for the same display. - Do not call ddca_stop_watch_displays() at library termination if client has already called it. - Use mutexes to control access to corruptable data structures. - Memory leaks. #### Display Change Detection - Alternative algorithms for detecting display changes, specified by option ***--watch-mode*** - watch mode XEVENT - Scans for changes only when a X11 change notification occurs. (Uses X11 API extension RANDR, which is also implemented on Wayland.) - watch mode POLL - doesn't use X11 - doesn't rely on /sys - reads EDIDs in polling loop - can consume a significant amount of CPU time on older machines - watch mode DYNAMIC (the default) - resolves to XEVENT on X11 or Wayland, otherwise to POLL - Extensively reworked display change detection - use /sys to get EDID if possible - handle MST hub devices if driver/device allow - not all drivers work - only perform stabilization for removed display - not checking for asleep - Named options affecting display change detection: - --watch-mode POLL, XEVENT, DYNAMIC - --enable/disable-try-get-edid-from-sysfs (default is --enable-try-get-edid-from-sysfs) - options ***--xevent-watch-loop-millisec*** ***--poll-watch-loop-millisec*** - Added **ddca_get_display_watch_settings()**, **ddca_set_display_watch_settings()** - Use constants in parms.h to specify retry intevals and counts - Handle possible delay between time that EDID can be read and DDC becomes functional - Added **flags** field in unused secton of DDCA_Display_Status Event, with bit DDCA_DISPLAY_EVENT_DDC_WORKING. Normally, this bit is set on display connection events. In case DDC is not immediately available after EDID detection, this bit is not set. If DDC subsequently becomes enabled, and event of type DDCA_EVENT_DDC_ENABLED occurs. - It's possible that there's a delay between the time a monitor is turned on (and X11/Wayland generate a display change event) and the time that DDC becomes enabled. There's a newly added flags field in DDCA_Display_Status_Event, with one bit defined, DDCA_DISPLAY_EVENT_DDC_WORKING. Normally, this bit is set in the emitted DDCA_Display_Status_Event. However, if DDC is not immediately enabled the bit is not set, and the display reference goes onto a recheck queue to be processed by a separate thread. An event of type DDCA_EVENT_DDC_ENABLED will be emitted if and when the recheck thread determines that DDC is working. - There's a tension in display change detection between minimizing the time between when X11/Wayland detects a monitor having been turned on and libddcutil issuing an event of type DDCA_DISPLAY_EVENT_CONNECTED versus checking and rechecking failed states (e.g. DDC not working). In many caes, the frequency and wait intervals are controlled by settings in file src/base/parms.h. ## [2.1.4] 2024-02-17 ### Shared Library - Reinstall previously deprecated and removed **ddca_create_display_ref()**, allowing existing clients to build unchanged. ## [2.1.3] 2024-02-07 ### Changed - Option ***--settings*** reports build options. ### Fixed - Memory leaks ### Shared Library The shared library **libddcutil** is backwardly compatible with the one in ddcutil 2.1.0. The SONAME is unchanged as libddcutil.so.5. The released library file is libddcutil.so.5.2.0. ### Fixed - Due to overly aggressive DDCA_Display_Ref validation, ddca_get_display_info() returned status DDCRC_ARG when obtaining information about an invalid display (i.e. one for which the EDID is detected but DDC communication fails). This fixes ddcui issue #55, which reported an abort if a display was invalid. - Checking for whether the video adapter supports DRM was consolidated. This fixes a case where all displays were reported to support DRM when that was not the case, causing incorrect display status change monitoring. ## [2.1.2] 2024-01-27 ### General ### Added - Option ***--vstats*** reports minimum, maximum, and average successful sleep multiplier ### Changed - Make hidden option ***--min-dynamic-multiplier*** non-hidden - Revert **ddca_get/set_sleep_multiplier()** to 2.0.0 semantics - Allow for the fact that the proprietary Nvidia driver always reports the value of /sys/class/drm//enabled as "disabled" ### Fixed - Invalid assert when checking how monitor reports unsupported features. (Issue #371) - Segfault in environment command when examining procfs if compiled using clang option -flto (Issue #354) - Bring man page up to date (Issue #364) ### Shared Library The shared library **libddcutil** is backwardly compatible with the one in ddcutil 2.1.0. The SONAME is unchanged as libddcutil.so.5. The released library file is libddcutil.so.5.1.1. ### Changed - **ddca_start_watch_displays()** requires that all video drivers support DRM. If the API call fails, detailed error information is available using **ddca_get_error_detail()**. - Additional syslog messages ### Fixed - SIGABRT in API calls that have a display reference or handle argument if **ddca_init2()** (or **ddca_init()**) had not been called. This caused KDE PowerDevil to repeatedly crash and restart. - Fix the check of whether all video drivers implement DRM, required for display hotplug detection. ## [2.1.0] 2024-01-16 ### General #### Added - Option ***--skip-ddc-checks*** - Skips initialization checks to confirm that DDC communication is working and the monitor properly uses the unsupported feature bit in Get Feature Reply packets, thereby improving initialization time. - Cross-instance locking (experimental). Uses flock() to coordinate I2C bus access to /dev/i2c devices when multiple instances of ddcutil or libddcutil are executing. Enabled by option ***--enable-cross-instance-locks***. - Option ***--min-dynamic-multiplier*** Specifies a floor to how low dynamic sleep adjustment sets the sleep multiplier. (experimental) #### Changed - Multiple "Options:" lines in an ini file segment are combined - Option ***--help***: - Only show extended information when ***--verbose*** specified - Option ***--version***: - Show only the version, without prefix if ***--brief*** specified - Include detailed build information if ***--verbose** specified - I2C bus examination during initialization can be parallelized, improving performance (This is distinct from the ddc protocol checking.) This is an experimental feature. It can be enabled by using a low value as an argument to option ***--i2c-init-async-min***, e.g. ***--i2c-init-async-min 4***. THIS OPTION IS DISABLED BY DEFAULT AS IT OCCASIONALLY TRIGGERS A BUG IN DRIVER amdgpu THAT CAN CAUSE THE MOUSE AND KEYBOARD TO BECOME UNRESPONSIVE. See freedesktop.org bug report "lockup in dce_i2c_submit_command_hw" at https://gitlab.freedesktop.org/drm/amd/-/issues. - Command detect: better messages when laptop display detected - do not report "DDC communication failed" - report "Is laptop display" instead of "Is eDP device" or "Is LVDS device" - Better accomodate the variation in use of sysfs by different drivers - Turned off unconditional message that reported an elusive Nvidia/i2c-dev driver compatibility error. The incompatibility has been full diagnosed as being caused by use of a legacy proprietary Nvidia driver. A message is still written to the system log. - Make more extensive use of the system log. - Options ***--enable-displays-cache***, ***--disable-displays-cache*** are marked hidden since displays caching is not a released feature. - Deprecate vaguely named option ***--force***. Replace its single use with option ***--permit-unknown-feature***. - Deprecate vaguely named option ***--async***. Use ***--ddc-checks-async-min*** - Deprecate vaguely named option ***--ddc***. Use option ***--ddcdata***, which more clearly indicates that it causes DDC data errors to be reported. - **configure** option ***--enable-asan*** causes libasan to be linked into binaries - **configure** option ***--enable-x11*** is deprecated. The X11 API is no longer used. #### Fixed - Better handling of DDC Null Message recognition and adjustments - Dynamic sleep: make it easier to reduce time - once high didn't come down - Command detect: ensure output of model name, serial number, and extra display descriptor use only ASCII character in the range 0..127. - Some USB-only code was not iftested out when **configure** option ***--disable-usb*** was set. (Issue 355) - Always set sleep multiplier to at least 1.0 for commands **setvcp** and **scs**. Addresses reports that aggressive optimization caused setvcp to fail. - Cross-thread locking handles situtations where a display ref does not yet exist, e.g. reading EDID. - Memory leaks. ### Shared library The shared library **libddcutil** is backwardly compatible with the one in ddcutil 2.0.0. The SONAME is unchanged as libddcutil.so.5. The released library file is libddcutil.so.5.1.0. #### Added - Implemented display hotplug event detection - Requires DRM video drivers (e.g. amdgpu, i915) - Can detect physical connection/disconnection and DPMS sleep status chanes, but the effect of turning a monitor on or off is monitor dependant and cannot reliably be detected. - Enabled by libddcutil option ***--enable-watch-displays***, or API call **ddca_enable_start_watch_displays()** - API uses callbacks to report report status changes to client - new status codes possible for many current API functions: DDCRC_DISCONNECTED, DDCRC_DPMS_ASLEEP - When a display connection event is reported, the client should call **ddca_redetect_displays()** - **ddca_validate_display_ref()**: Exposes the validation that occurs on any API call that has a DDCA_Display_Ref argument. Can be used to check whether a monitor asleep, disconnected, etc. - New functions for sleep multiplier control: - **ddca_enable_dynamic_sleep() - **ddca_disable_dynamic_sleep() - **ddca_get_current_sleep_multiplier() - **ddca_set_display_sleep_multiplier() - **ddca_init2()** replaces **ddca_init()**, which is deprecated: Has an additional argument for collecting informational msgs. Allows for not issuing information messages regarding the assembly of options and parsing directly from libddcutil to the terminal (now enabled by setting flag DDCA_INIT_OPTIONS_ENABLE_INIT_MSGS), but instead gives client complete control as to what to do with the messages. #### Changed - Functions that depend on initialization and that return a status code now return DDCRC_UNINITIALIZED if ddca_init() failed. - Revert **ddca_get_sleep_multiplier()**, **ddca_set_sleep_multiplier()** to their pre 2.0 semantics changing the multiplier on the current thread. However, these functions are marked as deprecated. #### Fixed - Argument passing on **ddca_get_any_vcp_value_using_implicit_type()** - Fixed cause of assert() failure in **ddca_init()** when the libopts string argument has a value and the configuration file is enabled but no options are obtained from the configuation file. - Contents of the libopts arg were added twice to the string passed to the libddcutil parser. ## [2.0.0] 2023-09-25 Release 2.0.0 contains extensive changes. Shared library libddcutil is not backwards compatible. #### Added - Install /usr/lib/modules-load.d/ddcutil.conf. Ensures that driver i2c-dev is loaded. - Install file /usr/share/udev/rules.d/60-ddcutil-i2c.rules, autmatically granting the logged on user read/write access to /dev/i2c devices for video displays. For most configurations, use of group i2c is no longer necessary. - Command options not of interest to general users are now hidden when help is requested. Option ***--hh*** exposes them, and implies option ***--help***. - Option ***--noconfig***. Do not process the configuration file. - Option ***--verbose***. If specified on the command line, the options obtained from the configuration file are reported. - Added utility options --f7, --f8, --i2, --s1, --s2, --s3, --s4, --fl1, --fl2 These options are for temporary use during development. The current use of the utility options is reported by option ***--settings***. - Added utility command C1 for temporary use during development. - Added option ***--enable-mock-data*** for testing - Option ***--trcfrom***. Traces the call stack starting with the specified function. This option applies only to functions for which tracing has been enabled. - API performance profiling - Added options ***--ignore-hiddev*** and ***--ignore-usb-vid-pid*** - Added: Sample file nvidia-i2c.conf that can be installed in directory /etc/modprobe.d to set options sometimes needed by the proprieatry NVidia video driver. - Added option ***--discard-cache*** to discard cached data at the start of program execution. Valid arguments are ***capabilities***, ***dsa***, and ***all***. - Command **discard [capabilites|dsa|all] cache(s)** discards cached data. - Option ***--pid*** (alt ***--process-id***) prepends the process id to trace messages. - Command **traceable-functions*** lists functions that can be traced by name, i.e. ones that can be specified as a ***--trcfunc*** argument. - If using X11, terminate immediately if a DPMS sleep mode is active. #### Changed - The dynamic sleep algorithm has been completely rewritten to both dynamically increase the sleep-multiplier factor (as needed) and decrease the sleep multiplier factor (insofar as possible). Data is maintained across program executions in file $HOME/.cache/ddcutil/stats. Option ***-dsa***, or one of its variants such as ***--enable-dsa*** turn it on. - Option ***--sleep-multiplier***: 0 is now allowed as an argument. Some DisplayPort monitors have been observed to work with this value. - Writing to the system log has been generalized. Option ***--syslog *** controls what is written to the system log. Recognized levels are NEVER, ERROR, WARN, INFO, and DEBUG. This option replaces ***--enable-syslog***, ***--disable-syslog***, and ***--trace-to-syslog***. - **environment --verbose**: Option ***--quickenv*** skips some slow tests such as use of program i2cdetect. - **environment --verbose**: extended sysfs scan for ARM SOC devices to explore how those devices use /sys - Detailed statistics are now maintained on a per-display instead of per-thread basis. - Option ***--vstats*** includes per-display statistics in its reports. It takes the same arguments as ***--stats***. - Cached capabilities are not erased by ddcutil calls that are not executed with ***--enable-capabilities-cache***. This makes the behavior the same as cached displays and cached performance statistics. - **environment --verbose** disables caching, reports contents of cached files. - loosen criteria for when to try fallback methods to read EDID when using USB to communicate with Eizo monitors - udev rule changes: - install /usr/lib/udev/rules.d/60-ddcutil-usb.rules - rename /usr/lib/udev/rules.d/60-ddcutil.rules to 60-ddcutil-i2c.rules - update and rename sample rules files installed in /usr/share/data/ddcutil as 60-ddcutil-i2c.rules and 60-ddcutil-usb.rules. The user can modify these files and install them in /etc/udev/rules.d to override the files installed in /usr/lib/udev/rules.d. - ***--enable-dsa*** is a valid synonym for ***--enable-dynamic-sleep*** - Display detection improved - Rework the algorithm for detecting display communication and testing how invalid features are reported. - Handle the phantom monitor case where a MST capabile monitor is detected as a separeate i2c bus/drm connector along with that on the video card - Command **detect** improved: - verbose output: - Reports the sysfs DRM values for dpms, enabled, and status - Reports if I2C slave address x37 is responsive - reports an error summary if DDC communication fails - Issue warnings that output may be inaccurate if the monitor is sleeping or if it cannot be determined how unsupported features are indicated. - Messages regarding DDC data errors (controlled by option ***--ddc***) are written to the system log with level LOG_WARNING instead of LOG_NOTICE. #### Fixed - More robust checks during display detection to test for misuse of the DDC Null Message and all zero getvcp response to indicate unsupported features. - Option ***--help***: Document **ELAPSED** as a recognized statistics class - ddca_dfr_check_by_dref(): do not return an error if no user defined feature file exists for the monitor - Recognize (but always report failure for) CHKUSBMON command even when ddcutil not built with USB support. - Improve reporting of /dev/hiddev* open failures to reduce confusion caused by this typically benign error. - Check that no display identifier is included on commands that don't use one - Increase buffer size to allow for a Get Feature Reply packet that contains an incorrectly large length field. - Change the USB infomation shown for option ***--version*** to emphasize that ddcutil uses USB for communicating with the monitor's Virtual Control Pandl, not for video transmission. - Memory leaks ### Shared library changes The shared library **libddcutil** in is not backwardly compatible. The SONAME is now libddcutil.so.5. The released library file is libddcutil.so.5.0.0. Library initialization has been reworked extensively to move operations that can fail and other aspects that should be under control of the library user into a new function **ddca_init()**. This function: - controls the level of messages written to the system log - optionally processes options obtained from the **ddcutil** configuration file - processes additional options passed as a string - sets error information for ddca_get_error_detail() If this function is not called by the user program, any API function that relies on its processing invokes **ddca_init()** using arguments such that it never fails, e.g. the configuration file is not processed. Added typedef - struct DDCA_Display_Detection_Report Added functions: - ddca_init() See above. - ddca_register_display_detection_callback(): Registers a function of type DDCA_Display_Status_Func which will be called to inform the client of display hotplug events. - ddca_library_filename(): Returns the fully qualified name of the shared library. Changed functions: - ddca_report_display_info() returns DDCA_Status instead of void - ddca_get_feature_name() implementation restored Changed semantics: The semantics of some functions have changed, reflecting the fact that some statistics are now maintained on a per-display rather than per-thread basis. - ddca_set_sleep_multiplier(), ddca_get_sleep_multiplier(). Instead of operating on the current thread, these functions operate on the display, if any, open in the current thread. - ddca_set_default_sleep_multiplier(), ddca_get_default_sleep_multiplier() Operate on newly detected displays, not new threads. Removed functions: With the ability to configure libddcutil operation both by the ddcutil configuration file and by passing an option string in the ddca_init() arguments, several API functions are no longer needed and have been removed: Max-tries options: - ddca_max_max_tries() - ddca_get_max_tries() - ddca_set_max_tries() - ddca_set_default_sleep_multiplier(), ddca_set_global_sleep_multiplier() - ddca_get_default_sleep_multiplier(), ddca_set_global_sleep_multiplier() Trace options: - ddca_add_traced_function() - ddca_add_traced_file() - ddca_set_trace_groups() - ddca_add_trace_groups() - ddca_trace_group_name_to_value() - ddca_set_trace_options() USB enablement: - ddca_enable_usb_display_detection - ddca_disable_usb_display_detection Miscellaneous: - ddca_enable_force_slave_adress() - ddca_is_force_slave_address_enabled() - ddca_enable_error_info() Most per-thread statistics are now instead maintained on a per-display basis. The following functions are no longer useful and have been removed - ddca_set_thread_description() - ddca_append_thread_description() - ddca_get_thread_desription() Remove previously deprecated functions: - ddca_open_display(). Use ddca_open_display2(). - ddca_create_display_ref(). Use ddca_get_display_ref() - ddca_free_display_ref(). Had become a NO-OP. All display references are persistent Symbols for functions and enums that had previously been removed from ddcutil_c_api.h are no longer exported. Options that apply only to libddcutil (Specified in the ddcutil configuration file or passed to ddca_init()) - Option ***--profile-api***. Applies only to **libddcutil**. Statistics for API functions that perform display IO are collected and subsequently reported when the library is terminated. - Option ***--trcapi***. Trace the call stack for a specified API function. #### Building ddcutil - configure options --enable-syslog/--disable-syslog have been eliminated. Use runtime option ***--syslog NEVER*** to disable all writes to the system log. - Use of shared library **libkmod** eliminated. - Shared library **libjansson** is now required ## [1.4.5] 2023-09-18 #### Building ddcutil - The autotools **configure** command now recognizes ***--enable-install-lib-only***. If specified, command **make install** only installs the shared library. This is intended to facilitate installation of **libddcutil.so.4** along with the upcoming **libddcutil.so.5**. ## [1.4.2] 2023-02-17 ### Added - **ddcutil** installation installs files /usr/lib/modules-load.d/ddcutil.conf and /usr/lib/modules-load.d#libddcutil.conf to ensure that kernel module i2c-dev is loaded at boot time if it is not built into the kernel. There are two files so that when split up into distribution packages, each of the command line **ddcutil** package and the shared library **libddcutil** package installs a file. ## [1.4.1] 2023-01-16 ### Fixed - The default sleep-multipler value was 0, instead of 1. This resulted in failure of most DDC/CI operations, including display detection. ## [1.4.0] 2023-01-04 ### Added - **ddcutil** installation installs file /usr/lib/udev/rules.c/60-ddcutil.rules. This udev rule uses tag uaccess to give the logged on user read/write access to /dev/i2c devices associated with video adapters. Configuring use of group i2c is no longer necessary. - configure options ***--enable-syslog*** and ***--disable-syslog*** control whether messages are written to the system log. The default is enabled. ### Changed - The ability to use the write()/read() interface of i2c-dev has been restored. It is needed to work around a bug in the proprietary Nvidia driver. By default, ioctl() interface is used for all drivers. If the Nvidia bug is detected, the write()/read() interface is used instead. Command line options ***--use-file-io*** and ***--use-ioctl-io*** affect this default behavior. When i2c-dev's file io interface is used, option ***--force-slave-address*** is again meaningful. - Option ***--sleep-multiplier*** and API functions **ddca_set_sleep_multiplier_value()**, **ddca_set_default_sleep_multiplier_value()** now accept 0 as a valid argument. - The ddcutil command parser reports an error if a display selection option (e.g. ***--bus***) is given on a command to which it does not apply. - Write additional error and information messages to the system log. - Eliminate message "Is DDC/CI enabled in the monitor's on-screen display?" It's rarely the cause of communication failures. ### Fixed - Warn of a possibly invalid DRM connector name in **detect** output if monitors with identical EDIDs are used with the proprietary nvidia driver. - Handle /dev/i2c device names with a double hyphen, e.g. /dev/i2c--3. - Better libddcutil handling of configuration file errors. Do not abort initialization in case of errors. - Fix interpretation of digital display type bits for EDID version 1.4 - Miscellaneous segfaults. ## [1.3.2] 2022-09-04 ### Changed - Modify tarball creation to eliminate garbage and otherwise unneeded files. ## [1.3.0] 2022-07-19 ### Added - Command **detect**: - Issue warning for monitors for which **ddcutil** should not be used to change settings. - Currently only entry is Xaomi model "Mi Monitor" - Debug messages. Environment variables DDCUTIL_DEBUG_PARSE, DDCUTIL_DEBUG_MAIN, DDCUTIL_DEBUG_LIBINIT can be set to enable trace messages in command line **ddcutil** or shared library **libddcutil.so** during initialization and before command options. ### Changed - Option ***--force-slave-address*** no longer has any effect. The dev-i2c ioctl() interface is now used exclusively instead of write() and read() calls for writing to and reading from the I2C bus. As a result, ioctl(SLAVE_ADDRESS), which has been the source of EBUSY errors from driver i2-dev, is no longer used. In principle, EBUSY errors are still possible from within individual video drivers, but this has never been observed. - Sleeps immediately after opening a /dev/i2c device and after completion of a read operation are completely eliminated. The sleep-suppression related uptions, ***--sleep-less***, ***--less-sleep, ***--enable-sleep-suppression***, and ***--disable-sleep-suppression*** no longer have any effect. - Option ***--dca***: The Dynamic Sleep Adjustment algorithm was rewritten to more sensibly increment sleep times after before each retry. - Commands **getvcp** and **vcpinfo**: - Allow specification of multiple feature codes, for example ***ddcutil getvcp 10 12*** , ***ddcutil vcpinfo 14 16 18 1a*** - Command **detect**: - Option ***--verbose*** produces addtional information: - The product code is reported in hex as well as decimal - The EDID source field is set to **I2C** in the normal case where the EDID is read directly from slave address X50. Alternative values include **USB**, **X11**, and **SYSFS**. - Command **environment**: - Scanning of /sys by option ***--verbose*** has been improved. - Add msg re SYSENV_QUICK_TEST environment variable - Command **interrogate**: - Set --disable-capabilities-cache - More user friendly messages at startup regarding /dev/i2c buses that cannont be opened. If the problem is inadequate permissions (EACCES), the user is directed to www.ddcutil.com/permissions. - Better handle malformed EDIDs - Trailing blanks on model and serial number are stripped. This affects commands **detect --terse**, **loadvcp** and **dumpvcp**, and also the file names of user defined features. - Option ***--stats***: - I2C ioctl() calls for reading and writing are now reported as type IE_IOCTL_WRITE and IE_IOCTL_READ rather than IE_OTHER - IE_WRITE_READ stats are no longer reported, as they are redundant - Source code has been extensively cleaned up. In particular, directory **adl** containing code for the old proprietary AMD video driver, has been removed. - Building ddcutil: - Library **libi2c.so** is no longer linked. It was needed only for some experimental code. libddcutil: - ddca_get_display_refs(), ddca_get_display_info_list2(): - Open errors can be retrieved using ddca_get_error_info(). Note that the API calls still succeed. - Deprecated API functions have no effect: - ddca_enable_force_slave_address(), ddca_is_force_slave_address_enabled() ### Fixed - The sleep multiplier value was not respected for new API threads. - User Defined Features: Keyword **NC** set the incorrect flag in a feature descriptor. - Option **--dsa**: Fix adjustment factor calculation due to incorrect variable type. - Fixed a segfault that occurred at **ddcui** startup. The fault was in a trace message for function ddc_start_watch_displays() which watches for displays that are added or removed. - Fixed a segfault in **ddcutil** initialization because of unexpected contents in sysfs. - Do not use glib function g_byte_array_steal(), which requires glib 2.60. ddcutil requires only glib 2.40. - Miscellaneous memory leaks - Double count I2C writes in stats. ## [1.2.2] 2022-01-22 ### Added - API function ddca_enable_force_slave_address() - API function ddca_is_force_slave_address_enabled() ### Changed - Improve handling of and messages regarding DDC communication failures with errno EBUSY. In particular, this error occurs when driver ddcci is loaded. - Command **detect**: If DDC communication fails with error EBUSY, report the display as "Busy" instead of "Invalid" and suggest use of option ***--force-slave-address***. - Command **environment**: Suggest use of option ***--force-slave-address*** if driver ddcci is detected. - Messages re EBUSY errors are always written to the system log. - Command **detect**: - Do not report the EDID source unless there is a value to show. This value is set only for USB connected monitors. - Show extended output based on option ***--verbose***, not undocumented option ***--very-verbose***. - Report color bit depth if EDID version >= 1.4 - Command **environment**: Simplify the exploration of sysfs. - API changes: - Field latest_sl_values in struct DDCA_Feature_Metadata struct is no longer set, - API function ddca_report_display_info(): include binary serial number - Building and porting: - When building ddcutil, allow for building a static library if **configure** option ***--enable-static*** is set. Linux distributions frown on packaging static libraries, but if a user wants to build it who am I to judge. By default, static libraries are not built, - Replace use of Linux specific function **__assert_fail()** with **exit()** in traced assertions. **__assert_fail** is used in the Linux implementation of **assert()**, but is not in the C specification. This can present a problem in porting ddcutil. - Code cleanup: - Delete incomplete, experimental code for asynhronous feature access, including files src/ddc/ddc_async.c/h. - Remove unused files src/util/output_sink.c/h. ### Fixed - Only write Starting/Terminating messages to the system log if option ***--syslog*** is specified. - Avoid compilation warnings when assert() statments are disabled (NDEBUG is defined). - Fixed a segfault in the debug/trace code of ddca_get_display_refs() - Memory leaks. ## [1.2.1] 2021-11-15 ### Added - Option ***--syslog***: Send trace and debug messages to the system log in addition to the trace location. - Option ***--wall-timestamp***, ***--wts***: Prefix trace and debug messages with the current wall time. - Option ***--settings***: Report option settings in effect. ### Changed - Details of current settings are no longer reported by every command invocation when option ***--verbose*** is specified. Use option ***--settings*** to control option reporting. - Removed sample program demo_watch_displays. ### Fixed - Numerous memory leaks, in particular ones triggered by ddca_redetect_displays(). - Build failure if configure option ***--enable-x11=no*** was specified. - API functions ddc_open_display(),ddc_open_display2() now always return DDCRC_ALREADY_OPEN if the the display is already open in the current thread. Previously an assert() failure would occur under certain circumstances. - Options ***--disable-capabilities-cache***, ***--disable-udf*** not respected - Proof of concept code that watches for display hotplug events ## [1.2.0] 2021-09-28 ### Added - libddcutil log file - libddcuti and ddcutil write critical events to syslog - API function ddca_add_trace_group() - API function ddca_extended_version_string() - API function ddca_redetect_displays() - API function ddca_get_display_refs() - API function ddca_get_display_info() - API function ddca_free_display_info() - Macro DDCUTIL_VSUFFIX ### Changed - If possible, command **ddcutil environment --verbose** calls **get-edid|parse-edid** as an additional EDID check. - Additional validation of DDCA_Display_Ref and DDCA_Display_Handle arguments to API functions - Improved tracing of assert() failures - --enable-capabilities-cache is now the default - libddcutil name is now libddcutil.so.4.1.0 - Command **detect**: improved analysis of /sys - Command **detect**: ***--verbose*** option reports raw EDID - Option ***--help*** does not report undocumented option ***--very-verbose***. ### Fixed - Incorrect assembly of sysfs path definitions in **ddcutil environment --verbose** - ddcutil diagnostics were not finding module i2c-dev if the system (e.g. NixOS) used a non-standard location for the modules directory (Issue #178). The checks have been rewritten to use libkmod. - Eliminate repeated messages from the experimental display hotplug detection code if no /sys/class/drm/cardN devices exist. (libddcutil) ## [1.1.0] 2021-04-05 For details, see [ddcutil Release Notes](https://www.ddcutil.com/release_notes). ### Added - Configuration file **ddcutilrc**, located on the XDG config path. - Cache monitor capabilities strings to improve performance of the **capabilities** command. Controlled by options ***--enable-capabilities-cache***, ***--disable-capabilities-cache***. - Workarounds for problems in DRM video drivers (e.g. i915, AMDGPU) when displays are connected to a docking station. The same monitor can appear as two different /dev/i2c devices, but only one supports DDC/CI. If possible these are reported as a "Phantom Display" instead of as "Invalid Display". Also, try to work around problems reading the EDID on these monitors, which can cause the monitor to not be detected. - Option ***--edid-read-size 128*** or ***--edid-read-size 256*** forces **ddcutil** to request that number of bytes when reading the EDID, which can occasionally allow the EDID to be read successfully. - Issue warning at startup if driver i2c-dev is neither loaded nor built into the kernel. ### Changed - By default, files generated by **dumpvcp** are saved in the XDG_DATA_HOME directory. - **environment --verbose** has more detailed reporting of relevant sections of /sys. - Additional information on **detect --verbose**. - Additional functions are traceable using option ***--trcfunc*** - User defined features are enabled by default. ### Fixed - Regard IO operations setting errno EBUSY as recoverable, suggest use of option ***--force-slave-address***. (EBUSY can occur when ddcontrol's ddcci driver is loaded.) - Fix build failure when configure option ***--disable-usb*** is combined with ***--enable-envcmds***. - On AMD Navi2 variants, e.g. RX 6000 series, **ddcutil** display detection put the GPU into an inconsistent state when probing a SMU I2C bus exposed by the GPU. This change ensures that **ddcutil** does not attempt to probe such buses. rockowitz-ddcutil-7a384a9/COPYING000066400000000000000000000432541510573515300166050ustar00rootroot00000000000000 GNU 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. Copyright (C) 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. , 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. rockowitz-ddcutil-7a384a9/Makefile.am000066400000000000000000000113321510573515300175760ustar00rootroot00000000000000# Top level Makefile.am # Copyright (C) 2014-2023 Sanford Rockowitz # SPDX-License-Identifier: GPL-2.0-or-later # To automatically update libtool script if it becomes out of date LIBTOOL_DEPS = @LIBTOOL_DEPS@ # From autoconf manual: # ... if you use aclocal from Automake to generate aclocal.m4, you must also # set ACLOCAL_AMFLAGS = -I dir in your top-level Makefile.am. # Due to a limitation in the Autoconf implementation of autoreconf, these # include directives currently must be set on a single line in Makefile.am, # without any backslash-newlines # Introspection does this. ACLOCAL_AMFLAGS = -I m4 ${ACLOCAL_FLAGS} DIST_SUBDIRS = src man data docs EXTRA_DIST = README.md NEWS.md CHANGELOG.md EXTRA_DIST += m4/ax_prog_doxygen.m4 if USE_DOXYGEN DOXYDIR = docs endif SUBDIRS = src man data $(DOXYDIR) # if ENABLE_GOBJECT_COND DISTCHECK_CONFIGURE_FLAGS = --enable-introspection # endif EXTRA_DIST += m4/introspection.m4 # install-data-local: # @echo "(Makefile) install-data-local):" # @echo " docdir = $(docdir)" if ENABLE_SHARED_LIB_COND libddcdocdir = $(datarootdir)/doc/libddcutil # libddcdoc_DATA = AUTHORS endif dist-hook: echo "(Makefile) Executing dist-hook..." chmod a-x ${distdir}/AUTHORS ${distdir}/COPYING ${distdir}/README.md find ${distdir} -name "*~" -exec rm -v {} \; find ${distdir} -name "*.ctl" -exec rm -v {} \; find ${distdir} -name "*.lst" -exec rm -v {} \; find ${distdir} -name "*.la" -exec rm -v {} \; find ${distdir} -name "*.old" -exec rm -v {} \; find ${distdir} -name "*.new" -exec rm -v {} \; find ${distdir} -name "*.tmp" -exec rm -v {} \; find ${distdir} -name "*old" -type d -prune -exec rm -fv {} \; find ${distdir} -name "*new" -type d -prune -exec rm -fv {} \; find ${distdir} -name ".gitignore" -exec rm -v {} \; rm -rfv ${distdir}/.github # Too many false positives: # alpha.clone.CloneChecker # alpha.deadcode.UnreachableCode # alpha.core.CastToStruct # Copied and adapted from colord # is calling autogen.sh within this file dangerous? clang: $(MAKE) clean; \ rm -rf clang; \ scan-build --use-analyzer=/usr/bin/clang \ -o clang-report \ ./autogen.sh \ --disable_gobject_api \ --enable-cffi \ --enable-cython \ ; \ scan-build --use-analyzer=/usr/bin/clang \ -o clang-report \ -enable-checker alpha.core.CastSize \ -enable-checker alpha.core.BoolAssignment \ -enable-checker alpha.core.Conversion \ make #failed: -enable-checker alpha.core.SizeofPtr # $(foreach v, $(.VARIABLES), @echo "$v = $$v") show: @echo "---> Show variables" @echo "" @echo "Set by PKG_CHECK_MODULES:" @echo " GLIB_CFLAGS = $(GLIB_CFLAGS) " @echo " GLIB_LIBS = $(GLIB_LIBS)" @echo " JANSSON_LIBS = $(JANSSON_LIBS)" @echo " JANSSON_CFLAGS = $(JANSSON_CFLAGS)" @echo " UDEV_CFLAGS = $(UDEV_CFLAGS)" @echo " UDEV_LIBS = $(UDEV_LIBS)" @echo " SYSTEMD_CFLAGS = $(SYSTEMD_CFLAGS)" @echo " SYSTEMD_LIBS = $(SYSTEMD_LIBS)" @echo " LIBUSB_CFLAGS = $(LIBUSB_CFLAGS)" @echo " LIBUSB_LIBS = $(LIBUSB_LIBS)" @echo "" @echo "Addtional:" @echo " prefix = $(prefix)" @echo " exec_prefix = $(exec_prefix)" @echo " libdir = $(libdir)" @echo " libexecdir = $(libexecdir)" @echo " top_srcdir = $(top_srcdir)" @echo " srcdir = $(srcdir)" @echo " pkgconfigdir: = ${pkgconfigdir}" @echo "" @echo " CFLAGS = $(CFLAGS)" @echo " CPPFLAGS = $(CPPFLAGS)" @echo " LDFLAGS = $(LDFLAGS)" .PHONY: clang show # ldconfig fails when executed in pbuilder due to permissions # just have to tell users to run it manually # install-exec-local: # @echo "(install-exec-local):" # ldconfig # uninstall-local: # @echo "(uninstall-local):=" # ldconfig # Rename to "all-local" for development all-local-disabled: @echo "" @echo "(Makefile:all-local) Variable values:" @echo " CLEANFILES: $(CLEANFILES)" @echo " CFLAGS: $(CFLAGS)" @echo " AM_CFLAGS: $(AM_CFLAGS)" @echo " CPPFLAGS: $(CPPFLAGS)" @echo " AM_CPPFLAGS: $(AM_CPPFLAGS)" @echo " AUTOMAKE_OPTIONS: $(AUTOMAKE_OPTIONS)" @echo " MAKELEVEL: $(MAKELEVEL)" @echo " MAKEFLAGS: $(MAKEFLAGS)" @echo " V: $(V)" @echo " AM_CFLAGS_STD: $(AM_CFLAGS_STD)" @echo "" rockowitz-ddcutil-7a384a9/NEWS.md000066400000000000000000000006671510573515300166510ustar00rootroot00000000000000ddcutil ======= The [ddcutil website](http://www.ddcutil.com) is the primary location of information for ddcutil users. Recent announcements can be found on the [home page](http://www.ddcutil.com). Earlier announcements are located at [prior announcements](http://www.ddcutil.prior_announcements). Detailed information about user-visible changes for each release are located at [release notes](http://www.ddcutil.com/release_notes). rockowitz-ddcutil-7a384a9/PACKAGING000066400000000000000000000015501510573515300167520ustar00rootroot00000000000000When packaging ddcutil for distributions, take note of the following: - Use of group i2c for permissions is in general no longer necessary. The rules in file /usr/lib/60-ddcutil-i2c.rules give the logged on user RW permission to /dev/i2c devices associated with monitors. However, use of tag uaccess does not address the case where the user has logged on using ssh. - File 60-ddcutil-usb.rules is not installed. Monitors that use USB for communication with their Virtual Control Panels are rare, and error messages caused by the rules, while benigh, can be confusing. - File /usr/lib/modules-load.d/ddcutil.conf ensures that driver i2c-dev is loaded if it is not built into the kernel. - By default, the build date and time are embedded in the ddcutil and libddcutil executables. If reproducable builds are required, use configure option --disable-build-timestamp.rockowitz-ddcutil-7a384a9/README.gitignore000066400000000000000000000004361510573515300204130ustar00rootroot00000000000000Starting with release 1.0.0, .gitignore specifies only files that should be ignored by any ddcutil git repository, e.g. build artifacts. File of local interest only should instead be specified in file .git/info/exclude, which which unlike .gitignore is not tracked in the respository. rockowitz-ddcutil-7a384a9/README.md000066400000000000000000000056731510573515300170340ustar00rootroot00000000000000ddcutil ======= **ddcutil** is a Linux program for querying and changing monitor settings, such as brightness and color levels. Most monitors, other than laptop displays, have a Virtual Control Panel (VCP), which implements features defined in the Monitor Control Command Set (MCCS). Typically, **ddcutil** communicates with the monitor's VCP over an I2C bus, as per the Display Data Channel/Command Interface Standard (DDC/CI). Alternatively, some monitors (e.g. Eizo ColorEdge, Apple Cinema) provide a USB interface to the VCP, as described in the USB Monitor Control Class Specification. **ddcutil** can communicate with these monitors over USB instead of I2C. A particular use case for **ddcutil** is as part of color profile management. Monitor calibration is relative to the monitor color settings currently in effect, e.g. red gain. **ddcutil** allows color related settings to be saved at the time a monitor is calibrated, and then restored when the calibration is applied. The tarball/github project builds both command line (**ddcutil**) and shared library (**libddcutil**) executables. The command line executable does not depend on the shared library. For detailed information about **ddcutil**, see the project website: www.ddcutil.com. In particular, for a summary of key post-installation steps, including loading driver i2c-dev, see [Post-Installation Checklist](https://www.ddcutil.com/config_steps). More generally, for instructions on building and configuring **ddcutil**, see [Installation and Configuration](https://www.ddcutil.com/install_config_main/) The [ddcutil FAQ](https://www.ddcutil.com/faq) describes the causes and workarounds for many common (and not so common) issues. Once **ddcutil** is installed, online help is also available. Use the --help option or see the man page: ~~~: $ ddcutil --help $ man 1 ddcutil ~~~ References to the relevant specifictions can be found at www.ddcutil.com/bibliography. ### Installation Diagnostics If **ddcutil** is successfully built but execution fails, command `ddcutil environment` probes the I2C environment and may provide clues as to the problem. ### User Support Please direct technical support questions, bug reports, and feature requests to the [Issue Tracker](https://github.com/rockowitz/ddcutil/issues) on the github repository. Use of this forum allows everyone to benefit from individual questions and ideas. When posting questions regarding **ddcutil** configuration, please execute the following command, capture its output in a file, and submit the output as an attachement. ~~~ $ ddcutil interrogate ~~~ For further information about technical support, see https://www.ddcutil.com/tech_support. ### Maintaining **ddcutil** in Linux Distributions Those responsible for maintaining **ddcutil** related packages in Linux distributions should see [Notes for Linux Distribution Maintainers](https://www.ddcutil.com/mult_shared_libs). ## Author Sanford Rockowitz rockowitz-ddcutil-7a384a9/autogen.sh000077500000000000000000000002401510573515300175370ustar00rootroot00000000000000#!/bin/sh # assumes running from top level ddcutil directory autoreconf --force -I config -I m4 --install --verbose test -n "$NOCONFIGURE" || ./configure "$@" rockowitz-ddcutil-7a384a9/config/000077500000000000000000000000001510573515300170075ustar00rootroot00000000000000rockowitz-ddcutil-7a384a9/config/.gitignore000066400000000000000000000000161510573515300207740ustar00rootroot00000000000000* !.gitignore rockowitz-ddcutil-7a384a9/configure.ac000066400000000000000000001020501510573515300200260ustar00rootroot00000000000000# # ddcutil autotools configure script # # Copyright (C) 2014-2025 Sanford Rockowitz # SPDX-License-Identifier: GPL-2.0-or-later dnl General notes: dnl - Macro names in comments are written in lower case to avoid processing as actual macros ### ### Initial Setup ### AC_PREREQ([2.69]) m4_define([ddcutil_major_version], [2]) m4_define([ddcutil_minor_version], [2]) m4_define([ddcutil_micro_version], [3]) dnl ddcutil_version_suffix does not begin with hyphen, e.g. "dev", not "-dev" m4_define([ddcutil_version_suffix], [""]) # m4_ifelse(ddcutil_version_suffix,[], m4_define([ddcutil_version], [a]),define([ddcutil_version],[b])) dnl mf_define( [ddcutil_version], m4_format([%s.%s.%s%s],[ddcutil_major_version],[ddcutil_minor_version],[ddcutil_micro_version],[ddcutil_version_suffix]) m4_define([ddcutil_version], [ddcutil_major_version.ddcutil_minor_version.ddcutil_micro_version]) dnl m4_ifdef('ddcutil_version_suffix' ,m4_define([ddcutil_version], [ddcutil_major_version.ddcutil_minor_version.ddcutil_micro_version])) dnl It should be possible to define here the "fully qualified" version name, conditionally dnl containing the version suffix, but after hours of trying to get that to work (5/2021) dnl I gave up. It will be handled in the C code. dnl process command line args, perform initializations dnl sets among several output vars including PACKAGE_NAME, PACKAGE_VERSION, dnl PACKAGE_TARNAME (name of output package) dnl causes VERSION to be set in config.h AC_INIT([ddcutil],[ddcutil_version],[rockowitz@minsoft.com]) dnl define preprocessor symbols dnl was AC_DEFINE_UNQUOTED, but don't need extra handling? dnl symbol value set by comment AC_DEFINE( [VERSION_VMAJOR], [ ddcutil_major_version ], [ddcutil major version] ) AC_DEFINE( [VERSION_VMINOR], [ ddcutil_minor_version ], [ddcutil minor version] ) AC_DEFINE( [VERSION_VMICRO], [ ddcutil_micro_version ], [ddcutil micro version] ) AC_DEFINE( [VERSION_VSUFFIX],[ ddcutil_version_suffix ], [ddcutil version suffix] ) dnl substitute @PACKAGE_MAJOR@ etc. in Makefile.am with the value of the environment variable AC_SUBST( VERSION_VMAJOR, [ddcutil_major_version] ) AC_SUBST( VERSION_VMINOR, [ddcutil_minor_version] ) AC_SUBST( VERSION_VMICRO, [ddcutil_micro_version] ) AC_SUBST( VERSION_VSUFFIX, [ddcutil_version_suffix] ) AC_ARG_VAR(DBG, [Turn on script debugging messages(0/1)]) dnl AC_MSG_NOTICE([DBG = |$DBG|]) AM_CONDITIONAL(WARNINGS_ARE_ERRORS_COND, [test "x$ddcutil_version_suffix" != "x"] ) AS_IF( [test 0$DBG -ne 0], AC_MSG_NOTICE([debug messages enabled]), AC_MSG_NOTICE([debug messages disabled]) ) dnl reduce clutter, save files litmain.sh, config.guess, missing etc. here instead of top directory AC_CONFIG_AUX_DIR(config) dnl sanity check: verify a unique file in source directory: AC_CONFIG_SRCDIR([src/util/coredefs.h]) AC_CONFIG_HEADERS([config.h]) AC_CONFIG_MACRO_DIR([m4]) AC_CONFIG_FILES([ Makefile src/Makefile src/util/Makefile src/usb_util/Makefile src/base/Makefile src/vcp/Makefile src/dynvcp/Makefile src/sysfs/Makefile src/i2c/Makefile src/usb/Makefile src/ddc/Makefile src/dw/Makefile src/test/Makefile src/cmdline/Makefile src/app_sysenv/Makefile src/app_ddcutil/Makefile src/libmain/Makefile src/sample_clients/Makefile man/Makefile data/Makefile docs/Makefile docs/doxygen/Makefile src/public/ddcutil_macros.h data/ddcutil.pc ], ) dnl AC_CONFIG_FILES(package/upload_obsrpm, [chmod +x package/upload_obsrpm] ) dnl dnl AC_CONFIG_FILES(package/build_dpkg, [chmod +x package/build_dpkg] ) dnl dnl cannot chmod on build_dpkg, upload_obsrpm, since they will not exist within dpkg build environment dnl not working, why? # AC_DEFINE_UNQUOTED([DDCUTIL_MAJOR_VERSION], [$ddcutil_major_version], [ddcutil major version]) dnl Automake options to be applied to every Makefile.am in the tree: dnl The effect is as if each option were listed in AUTOMAKE_OPTIONS dnl removed -Werror from AM_INIT_AUTOMAKE to allow compilation to proceed dnl n. first option in our list is the required automake version AM_INIT_AUTOMAKE([1.14 -Wall -Wno-extra-portability foreign subdir-objects ]) dnl alternatively, add "silent-rules" to AM_INIT_AUTOMAKE dnl Eclipse warns that as of 2.68, AM_SILENT_RULES takes 0 arguments dnl but in 2.69 it only defaults to silent with argument "yes" dnl with "yes" arg, silent rules is the default AM_SILENT_RULES([yes]) AM_PROG_AR dnl explicitly initialize pkg-config in case first call to pkg_check_modules is within an if test: PKG_PROG_PKG_CONFIG required_packages= dnl Determines C compiler to use, sets output variable cc, ac_cv_prog_cc_c89 dnl Called by other macros, but must be called explicitly at top level for proper initialization # AC_PROG_C99 for CENTOS 7 in OBS, EOL 6/30/2024 m4_version_prereq(2.70, [AC_PROG_CC], [AC_PROG_CC_C99]) dnl AC_PROG_LIBTOOL, AM_PROG_LIBTOOL are deprecated names for older versions of LT_INIT dnl adds support for --enable/disable -static/shared, -with/without-pic configure flags LT_INIT([disable-static]) dnl Automatically update libtool script if it becomes out of date: AC_SUBST([LIBTOOL_DEPS]) ### ### Version specification ### # libtool versioning - applies to libddcutil # # See http://sources.redhat.com/autobook/autobook/autobook_91.html#SEC91 for details # # increment; # CURRENT If the API or ABI interface has changed (reset REVISION to 0) # REVISION If the API and ABI remains the same, but bugs are fixed. # AGE backward compatibility (i.e. number of releases prior to current # for which this release is backward compatible) # # Alternative comments: # # Here are a set of rules to help you update your library version # information: # # 1. Start with version information of `0:0:0' for each libtool library. # 2. Update the version information only immediately before a public # release of your software. More frequent updates are unnecessary, and # only guarantee that the current interface number gets larger faster. # 3. If the library source code has changed at all since the last update, # then increment revision (`c:r:a' becomes `c:r+1:a'). # 4. If any interfaces have been added, removed, or changed since the last # update, increment current, and set revision to 0. # 5. If any interfaces have been added since the last public release, then # increment age. # 6. If any interfaces have been removed since the last public release, # then set age to 0. # # The LT_... values are used to create the argument for the --version-info parm. # Note that this parm is processed differently depending on operating system. # For Linux, the second and third fields in the shared object name's suffix are # taken directly from the command line, while the first is calculated as current-age. # For example, if LT_CURRENT=13, LT_REVISION=4, LT_AGE=4, the geneated parm # is --version-info "13:1:4", and the generated SO name looks like xxx.so.9.4.1 dnl 7/29/19 first use, LT_CURRENT set to 1 dnl release 2.2.0, c:r:a = 7:0:2 -> libddcutil.so.5.2.0 dnl release 2.2.1, c:r:a = 8:0:3 -> libddcutil.so.5.3.0 dnl release 2.2.2, c:r:a = 9:0:4 -> libddcutil.so.5.4.0 LT_CURRENT=9 LT_REVISION=0 LT_AGE=4 AC_SUBST(LT_CURRENT) AC_SUBST(LT_REVISION) AC_SUBST(LT_AGE) ### ### Recognize command options for configure script ### ### ### Documented options ### AC_MSG_NOTICE( [Checking configure command options...] ) dnl # residual setting so that Makefile.am files don't break adl_header_dir="" AM_CONDITIONAL([HAVE_ADL_COND], [test -n "$adl_header_dir"] ) dnl *** configure option: --enable-lib AC_ARG_ENABLE([lib], [ AS_HELP_STRING([--enable-lib=@<:@yes/no@:>@], [Build shared library and clients@<:@default=yes@:>@] )], [enable_lib=${enableval}], [enable_lib=yes] ) dnl Set flag for automake.am: AM_CONDITIONAL([ENABLE_SHARED_LIB_COND], [test "x$enable_lib" = "xyes"] ) dnl ENABLE_SHARED_LIB_FLAG used in package/ddcutil_spec.in AS_IF([test "x$enable_lib" = "xyes"], AC_MSG_NOTICE( [lib... enabled] ) AC_SUBST(ENABLE_SHARED_LIB_FLAG, 1) AC_DEFINE( [BUILD_SHARED_LIB], [1], [If defined, buid shared library.]) , AC_MSG_NOTICE( [lib... disabled] ) AC_SUBST(ENABLE_SHARED_LIB_FLAG, 0) ) dnl *** configure option: --install-lib-only AC_ARG_ENABLE([install-lib-only], [ AS_HELP_STRING([--enable-install-lib-only=@<:@yes/no@:>@], [Install only shared shared librarys@<:@default=no@:>@] )], [enable_install_lib_only=${enableval}], [enable_install_lib_only=no] ) AM_CONDITIONAL([INSTALL_LIB_ONLY_COND], [test "x$enable_install_lib_only" = "xyes"] ) AS_IF([test "x$enable_install_lib_only" = "xyes"], AC_MSG_NOTICE( [install_lib_only... enabled] ) , AC_MSG_NOTICE( [install_lib_only... disabled] ) ) AS_IF([test "x$enable_lib" = "xno" -a "x$enable_install_lib_only" = "xyes" ], AC_MSG_ERROR( [--disable-lib contradicts --enable-install-lib-only] ) ) dnl *** configure option: --enable-build-timestamp AC_ARG_ENABLE([build-timestamp], [ AS_HELP_STRING([--enable-build-timestamp=@<:@yes/no@:>@], [Insert build date/time in executables@<:@default=yes@:>@] )], [enable_build_timestamp=${enableval}], [enable_build_timestamp=yes] ) dnl Set flag for automake.am: AM_CONDITIONAL([ENABLE_BUILD_TIMESTAMP_COND], [test "x$enable_build_timestamp" = "xyes"] ) AS_IF([test "x$enable_build_timestamp" = "xyes"], AC_MSG_NOTICE( [build-timestamp... enabled] ) AC_SUBST(ENABLE_BUILD_TIMESTAMP_FLAG, 1) AC_DEFINE( [BUILD_TIMESTAMP], [1], [If defined, include build date/time in executables.]) , AC_MSG_NOTICE( [build-timestamp... disabled] ) AC_SUBST(ENABLE_BUILD_TIMESTAMP_FLAG, 0) ) dnl *** configure option: --enable-envcmds AC_ARG_ENABLE([envcmds], [ AS_HELP_STRING([--enable-envcmds=@<:@yes/no@:>@], [Include environment and usbenvironment@<:@default=yes@:>@] )], [enable_envcmds=${enableval}], [enable_envcmds=yes] ) AS_IF([test "x$enable_envcmds" = "xyes"], AC_MSG_NOTICE( [envcmds... enabled (provisional) ] ) , AC_MSG_NOTICE( [envcmds... disabled] ) ) dnl *** configure option: --enable-udev AC_ARG_ENABLE([udev], [ AS_HELP_STRING([--enable-udev=@<:@yes/no@:>@], [Use UDEV@<:@default=yes@:>@] )], [enable_udev=${enableval}], [enable_udev=yes] ) dnl AS_IF([test "x$enable_udev" = "xyes"], dnl AC_MSG_NOTICE( [udev... enabled (provisional) ] ) dnl , dnl AC_MSG_NOTICE( [udev... disabled] ) dnl ) dnl *** configure option: --enable-usb AC_ARG_ENABLE([usb], [ AS_HELP_STRING( [--enable-usb=@<:@yes/no@:>@], [Support USB connected displays@<:@default=yes@:>@] )], [enable_usb=${enableval}], [enable_usb=yes] ) AS_IF([test "x$enable_usb" = "xyes"], AC_MSG_NOTICE( [usb... enabled (provisional) ] ) , AC_MSG_NOTICE( [usb... disabled] ) ) dnl *** configure option: --enable-drm AC_ARG_ENABLE([drm], [ AS_HELP_STRING( [--enable-drm=@<:@yes/no@:>@], [Use DRM@<:@default=yes@:>@] )], [enable_drm=${enableval}], [enable_drm=yes] ) AS_IF([test "x$enable_drm" = "xyes"], AC_MSG_NOTICE( [drm... enabled (provisional) ] ) , AC_MSG_NOTICE( [drm... disabled] ) ) dnl *** configure option: --enable-watch_displays AC_ARG_ENABLE([watch_displays], [ AS_HELP_STRING( [--enable-watch-displays=@<:@yes/no@:>@], [Watch for display changes@<:@default=yes@:>@] )], [enable_watch_displays=${enableval}], [enable_watch_displays=yes] ) AS_IF([test "x$enable_watch_displays" = "xyes"], AC_MSG_NOTICE( [watch-displays... enabled (provisional) ] ) , AC_MSG_NOTICE( [watch-displays... disabled] ) ) dnl *** configure option: --enable-x11 AC_ARG_ENABLE([x11], [ AS_HELP_STRING( [--enable-x11=@<:@yes/no@:>@], [Use X11@<:@default=yes@:>@] )], [enable_x11=${enableval}], [enable_x11=yes] ) # enable_x11=no # AS_IF([test "x$enable_x11" = "xyes"], # AC_MSG_NOTICE( [x11... Deprecated option ignored] ), # AC_MSG_NOTICE( [x11... disabled] ) # ) AS_IF([test "x$enable_x11" = "xyes"], AC_MSG_NOTICE( [x11... enabled (provisional) ] ) , AC_MSG_NOTICE( [x11... disabled] ) ) dnl *** configure option: --enable-static-functions-visible AC_ARG_ENABLE([static-functions-visible], [ AS_HELP_STRING( [--enable-static-functions-visible=@<:@no/yes@:>@], [Remove static qualifier from functions@<:@default=no@:>@] )], [enable_static_functions_visible=${enableval}], [enable_static_functions_visible=no] ) AM_CONDITIONAL([STATIC_FUNCTIONS_VISIBLE_COND], [test "x$enable_static_functions_visible" = "xyes"] ) AS_IF( [test "x$enable_static_functions_visible" = "xyes"], AC_DEFINE( [STATIC_FUNCTIONS_VISIBLE], [1], [If defined, remove static qualifier from function declarations and definitions.]) AC_MSG_NOTICE( [static_functions_visible... enabled] ) , AC_MSG_NOTICE( [static_functions_visible... disabled] ) ) dnl *** configure option: --enable-asan AC_ARG_ENABLE([asan], [ AS_HELP_STRING( [--enable-asan=@<:@no/yes@:>@], [Build for asan (address sanitizer)@<:@default=no@:>@] )], [enable_asan=${enableval}], [enable_asan=no] ) AM_CONDITIONAL([ASAN_COND], [test "x$enable_asan" = "xyes"] ) AS_IF( [test "x$enable_asan" = "xyes"], AC_DEFINE( [WITH_ASAN], [1], [If defined, building for Asan instrumentation.]) AC_MSG_NOTICE( [asan... enabled] ) , AC_MSG_NOTICE( [asan... disabled] ) ) dnl dnl *** configure option: --enable-trace dnl AC_ARG_ENABLE([trace], dnl [ AS_HELP_STRING( [--enable-trace=@<:@yes/no@:>@], [Output trace messages@<:@default=yes@:>@] )], dnl [enable_trace=${enableval}], dnl [enable_trace=yes] ) dnl AS_IF([test "x$enable_trace" = "xyes"], dnl AC_MSG_NOTICE( [trace... enabled] ) dnl AC_DEFINE([ENABLE_TRACE], [1], [If defined, enable trace messages.]) dnl , dnl AC_MSG_NOTICE( [TRACE... disabled] ) dnl ) dnl *** configure option: --enable-targetbsd AC_ARG_ENABLE([targetbsd], [ AS_HELP_STRING([--enable-targetbsd=@<:@no/yes@:>@], [Build for BSD@<:@default=no@:>@ (Developer-only)] )], [enable_targetbsd=${enableval}], [enable_targetbsd=no] ) dnl *** configure option: --enable-doxygen AC_ARG_ENABLE([doxygen], [ AS_HELP_STRING( [--enable-doxygen=@<:@no/yes@:>@], [Build API documentation using Doxygen (if it is installed)@<:@default=no@:>@ (Developer-only)] )], [enable_doxygen=${enableval}], [enable_doxygen=no] ) AM_CONDITIONAL([ENABLE_DOXYGEN_COND], [test "x$enable_doxygen" = "xyes"] ) AS_IF([test "x$enable_doxygen" = "xyes"], AC_MSG_NOTICE( [doxygen... enabled] ) , AC_MSG_NOTICE( [doxygen... disabled] ) ) ### ### Resolve choices for public options ### AC_MSG_NOTICE( [Resolving options...] ) dnl --enable-targetbsd => --disable-envcmds, --disable-usb, --disable-udev AS_IF([test "x$enable_targetbsd" = "xyes" -a "x$enable_envcmds" = "xyes" ], [ AC_MSG_NOTICE( [--enable-targetbsd forces --disable-envcmds] ) enable_envcmds=no ] ) AS_IF([test "x$enable_targetbsd" = "xyes" -a "x$enable_udev" = "xyes" ], [ AC_MSG_NOTICE( [--enable-targetbsd forces --disable-udev] ) enable_udev=no ] ) AS_IF([test "x$enable_targetbsd" = "xyes" -a "x$enable_usb" = "xyes" ], [ AC_MSG_NOTICE( [--enable-targetbsd forces --disable-usb] ) enable_usb=no ] ) AS_IF([test "x$enable_udev" != "xyes" -a "x$enable_usb" = "xyes" ], [ AC_MSG_NOTICE( [--disable-udev forces --disable-usb] ) enable_usb=no ] ) # --enable-install-lib-only => --disable-envcmds AS_IF([test "x$enable_install_lib_only" = "xyes" -a "x$enable_envcmds" = "xyes" ], [ AC_MSG_NOTICE( [--enable-install-lib-only forces --disable-envcmds] ) enable_envcmds=no ] ) ### ### Report resolved options and set conditionals, substitutions, and defines ### AM_CONDITIONAL([ENABLE_TARGETBSD_COND], [test "x$enable_targetbsd" = "xyes"] ) AS_IF([test "x$enable_targetbsd" = "xyes"], AC_MSG_NOTICE( [targetbsd... enabled] ) AC_DEFINE( [TARGET_BSD], [1], [If defined, building for BSD.]) AC_SUBST(ENABLE_TARGETBSD_FLAG, 1) , AC_MSG_NOTICE( [targetbsd... disabled] ) AC_SUBST(ENABLE_TARGETBSD_FLAG, 0) AC_DEFINE( [TARGET_LINUX], [1], [If defined, building for Linux.]) ) AM_CONDITIONAL([ENABLE_ENVCMDS_COND], [test "x$enable_envcmds" = "xyes"] ) AS_IF([test "x$enable_envcmds" = "xyes"], AC_MSG_NOTICE( [envcmds... enabled] ) AC_DEFINE( [ENABLE_ENVCMDS], [1], [If defined, enable environment commands.]) AC_SUBST(ENABLE_ENVCMDS_FLAG, 1) , AC_MSG_NOTICE( [envcmds... disabled] ) AC_SUBST(ENABLE_ENVCMDS_FLAG, 0) ) AM_CONDITIONAL([ENABLE_UDEV_COND], [test "x$enable_udev" = "xyes"] ) AS_IF([test "x$enable_udev" = "xyes"], AC_MSG_NOTICE( [udev... enabled] ) AC_DEFINE( [ENABLE_UDEV], [1], [If defined, use UDEV.]) AC_SUBST(ENABLE_UDEV_FLAG, 1) , AC_MSG_NOTICE( [udev... disabled] ) AC_SUBST(ENABLE_UDEV_FLAG, 0) ) AM_CONDITIONAL([ENABLE_USB_COND], [test "x$enable_usb" = "xyes"] ) AS_IF([test "x$enable_usb" = "xyes"], AC_DEFINE( [ENABLE_USB], [1], [If defined, enable USB communication.]) AC_SUBST( ENABLE_USB_FLAG, [1] ) AC_MSG_NOTICE( [usb... enabled] ) , AC_SUBST( ENABLE_USB_FLAG, [0] ) AC_MSG_NOTICE( [usb... disabled] ) ) AS_IF([test "x$enable_x11" = "xyes"], AC_MSG_NOTICE( [x11... enabled] ) , AC_MSG_NOTICE( [x11... disabled] ) ) ### Private options dnl dnl *** configure option: --enable-yaml dnl AC_ARG_ENABLE([yaml], dnl [ AS_HELP_STRING( [--enable-yaml=@<:@no/yes@:>@], [Enable YAML for external file parsing @<:@default=no@:>@] )], dnl [enable_yaml=${enableval}], dnl [enable_yaml=no] ) dnl AM_CONDITIONAL([ENABLE_YAML_COND], [test "x$enable_yaml" = "xyes"] ) dnl AS_IF([test "x$enable_yaml" = "xyes"], dnl AC_DEFINE( [ENABLE_YAML], [1], [Enable YAML for parsing.]) dnl AC_MSG_NOTICE( [yaml... enabled] ) dnl , dnl AC_MSG_NOTICE( [yaml... disabled] ) dnl ) dnl *** configure option: --enable-testcases AC_ARG_ENABLE([testcases], [ AS_HELP_STRING( [--enable-testcases=@<:@no/yes@:>@], [Include test cases @<:@default=no@:>@] (Developer-only) )], [include_testcases=${enableval}], [include_testcases=no] ) AM_CONDITIONAL([INCLUDE_TESTCASES_COND], [test "x$include_testcases" = "xyes"] ) AS_IF([test "x$include_testcases" = "xyes"], AC_DEFINE( [INCLUDE_TESTCASES], [1], [If defined, build with test cases.]) AC_MSG_NOTICE( [testcases... enabled] ) , AC_MSG_NOTICE( [testcases... disabled] ) ) dnl *** configure option: --enable-callgraph AC_ARG_ENABLE([callgraph], [ AS_HELP_STRING( [--enable-callgraph=@<:@no/yes@:>@], [Create .expand files for static call graph@<:@default=no@:>@] (Developer-only) )], [enable_callgraph=${enableval}], [enable_callgraph=no] ) AM_CONDITIONAL([ENABLE_CALLGRAPH_COND], [test "x$enable_callgraph" = "xyes"] ) AS_IF([test "x$enable_callgraph" = "xyes"], AC_MSG_NOTICE( [callgraph... enabled] ), AC_MSG_NOTICE( [callgraph... disabled] ) ) dnl *** configure option: --enable-failsim AC_ARG_ENABLE([failsim], [ AS_HELP_STRING( [--enable-failsim=@<:@no/yes@:>@], [Build with failure simulation@<:@default=no@:>@ (Developer-only)] )], [enable_failsim=${enableval}], [enable_failsim=no] ) AM_CONDITIONAL([ENABLE_FAILSIM_COND], [test "x$enable_failsim" = "xyes"] ) AS_IF( [test "x$enable_failsim" = "xyes"], AC_DEFINE( [ENABLE_FAILSIM], [1], [If defined, enable failsim.]) AC_MSG_NOTICE( [failsim... enabled] ) , AC_MSG_NOTICE( [failsim... disabled] ) ) dnl *** configure option: --enable-force-suse AC_ARG_ENABLE([force-suse], [ AS_HELP_STRING( [--enable-force-suse=@<:@no/yes@:>@], [Force SUSE target directories@<:@default=no@:>@ (Developer-only)] )], [enable_force_suse=${enableval}], [enable_force_suse=no] ) AM_CONDITIONAL([ENABLE_FORCE_SUSE_COND], [test "x$enable_force_suse" = "xyes"] ) AS_IF( [test "x$enable_force_suse" = "xyes"], AC_DEFINE( [ENABLE_FORCE_SUSE], [1], [If defined, force SUSE target directories.]) AC_MSG_NOTICE( [force-suse... enabled] ) , AC_MSG_NOTICE( [force-suse... disabled] ) ) dnl Note to self: use autoheader to regenerate config.h.in whenever new defines added ### ### Checks for typedefs, structures, and compiler characteristics. ### AC_CHECK_HEADER_STDBOOL AC_C_INLINE AC_C_BIGENDIAN AC_TYPE_SIZE_T AC_TYPE_SSIZE_T AC_TYPE_UINT16_T AC_TYPE_UINT32_T AC_TYPE_UINT8_T ### ### Checks for standard library functions. ### AC_FUNC_MALLOC AC_FUNC_REALLOC AC_FUNC_STRERROR_R AC_CHECK_FUNCS([clock_gettime memset nl_langinfo stpcpy strchr strdup strerror strrchr strtol]) dnl The dlopen() function is in the C library for *BSD and in dnl libdl on GLIBC-based systems AC_SEARCH_LIBS([dlopen], [dl dld], [], [ AC_MSG_ERROR([unable to find the dlopen() function]) ]) ### ### Checks for header files. ### AC_CHECK_HEADERS([fcntl.h langinfo.h libintl.h limits.h stdint.h stdlib.h string.h sys/ioctl.h termios.h unistd.h wchar.h dlfcn.h execinfo.h]) dnl i2c-dev.h is in linux-headers dnl i2c-dev.h not found: dnl AC_CHECK_HEADERS([i2c-dev.h]) dnl dnl libi2c and libi2c-dev have no .pc files. Check for header file instead. dnl AC_CHECK_HEADER( [i2c/smbus.h], dnl AC_MSG_NOTICE( [header file i2c/smbus.h found.] ), dnl AC_MSG_ERROR( [libi2c development package (e.g. libi2c-dev, name varies by distribution) >= 4.0 required.] ) dnl ) ### ### Required library tests ### dnl Notes on pkg_check_modules: dnl 1) appends to xxx_CFLAGS and xxx_LIBS the output of pkg-config --cflags|--libs dnl 2) if no action-if-false branch defined, pkg_check_modules terminates execution if not found dnl 9/2017: need >= 2.32 for g_thread_...() functions PKG_CHECK_MODULES(GLIB, glib-2.0 >= 2.40) required_packages="$required_packages glib-2.0 >= 2.40" PKG_CHECK_MODULES(JANSSON, jansson >= 2.0) required_packages="$required_packages jansson >= 2.0" AS_IF( [test "x$enable_udev" = "xyes" ], [ PKG_CHECK_MODULES(UDEV, libudev, [ libudev_found=1], [ libudev_found=0 AC_MSG_NOTICE( [The package providing libudev.h varies by Linux distribution and release.] ) AC_MSG_NOTICE( [It may be a udev specific package, e.g. libudev-dev, libudev-devel] ) AC_MSG_NOTICE( [or it may be part of systemd, e.g systemd-devel] ) AC_MSG_ERROR( [libudev not found] ) ] ) ] , ) dnl required_packages="$required_packages xrandr x11" dnl how to handle libudev? punt for now ### ### Optional library tests ### dnl TODO: use consistent pattern ### libusb dnl know that 1.0.8 fails, 1.0.20 works AS_IF([test "x$enable_usb" = "xyes"], [ PKG_CHECK_MODULES(LIBUSB, libusb-1.0 >= 1.0.15, [libusb_found=yes] ) ], [ AC_MSG_NOTICE( [usb disabled, not checking for libusb] ) ] ) dnl Logically, these debug messages belong within the $enable_usb test, but the dnl nested brackests make the code hard to read. It's LISP all over again. AS_IF( [test 0$DBG -ne 0], [ AC_MSG_NOTICE( [LIBUSB_CFLAGS: $LIBUSB_CFLAGS] ) AC_MSG_NOTICE( [LIBUSB_LIBS: $LIBUSB_LIBS] ) ]) ### libdrm AS_IF([test "x$enable_drm" = "xyes"], [ PKG_CHECK_MODULES(LIBDRM, libdrm >= 2.4.67, [libdrm_found=yes], [libdrm_found=no AC_MSG_WARN( [libdrm >= 2.4.67 not found. Forcing --disable-drm]) enable_drm=no ] ) ], [ AC_MSG_NOTICE( [drm disabled, not checking for libdrm] ) ] ) AM_CONDITIONAL([USE_LIBDRM_COND], [test "x$enable_drm" = "xyes"] ) AS_IF([test "x$enable_drm" = "xyes"], AC_DEFINE([USE_LIBDRM], [1], [Use libdrm]) AC_MSG_NOTICE( [drm... enabled] ) , AC_MSG_NOTICE( [drm... disabled] ) ) AS_IF( [test 0$DBG -ne 0], [ AC_MSG_NOTICE( [LIBDRM_CFLAGS: $LIBDRM_CFLAGS] ) AC_MSG_NOTICE( [LIBDRM_LIBS: $LIBDRM_LIBS] ) ]) AS_IF( [test "x$enable_drm" = "xno" -a "x$enable_watch_displays" = "xyes" ], [ AC_MSG_WARN( [DRM disabled, forcing display watch disabled] ) enable_watch_displays=no ]) AM_CONDITIONAL([WATCH_DISPLAYS_COND], [test "x$enable_watch_displays" = "xyes"] ) AS_IF([test "x$enable_watch_displays" = "xyes"], AC_DEFINE([WATCH_DISPLAYS], [1], [Watch for display changes]) AC_MSG_NOTICE( [watch displays.. enabled] ) , AC_MSG_NOTICE( [watch displays... disabled] ) ) dnl ### libyaml dnl dnl PKG_CHECK_MODULES(YAML, yaml-0.1) dnl dnl AS_IF([test "x$enable_yaml" = "xyes"], dnl [ PKG_CHECK_MODULES(YAML, yaml-0.1, dnl [libyaml_found=yes], dnl [libyaml_found=no dnl AC_MSG_WARN( [yaml-0.1 not found. Forcing --disable-yaml]) dnl enable_yaml=no dnl ] dnl ) dnl ], dnl [ AC_MSG_NOTICE( [yaml disabled, not checking for libyaml] ) ] dnl ) dnl dnl AM_CONDITIONAL([ENABLE_YAML_COND], [test "x$enable_yaml" = "xyes"] ) dnl AS_IF([test "x$enable_yaml" = "xyes"], dnl AC_DEFINE([ENABLE_YAML], [1], [Use yaml]) dnl AC_MSG_NOTICE( [yaml... enabled] ) dnl , dnl AC_MSG_NOTICE( [yaml... disabled] ) dnl ) dnl dnl AS_IF( [test 0$DBG -ne 0], dnl [ dnl AC_MSG_NOTICE( [YAML_CFLAGS: $YAML_CFLAGS] ) dnl AC_MSG_NOTICE( [YAML_LIBS: $YAML_LIBS] ) dnl ]) ### X11 dnl Duplicate of next section? AS_IF([test "x$enable_x11" = "xyes"], [ PKG_CHECK_MODULES(LIBX11, x11) PKG_CHECK_MODULES(XRANDR, xrandr) PKG_CHECK_MODULES(XEXT, xext) ]) AM_CONDITIONAL([USE_X11_COND], [test "x$enable_x11" = "xyes"] ) AS_IF([test "x$enable_x11" = "xyes"], AC_DEFINE([USE_X11], [1], [Use X11]) AC_MSG_NOTICE( [x11... enabled1] ) , AC_MSG_NOTICE( [x11... disabled1] ) ) dnl Note cflags and libs, but don't need to use in makefiles AS_IF( [test 0$DBG -ne 0], [ AC_MSG_NOTICE( [LIBX11_CFLAGS: $LIBX11_CFLAGS] ) AC_MSG_NOTICE( [LIBX11_LIBS: $LIBX11_LIBS] ) ]) ### DOXYGEN dnl AC_MSG_NOTICE([Start of DOXYGEN]) dnl AS_IF( [test "x$enable_doxygen" = "xyes"], dnl AC_MSG_NOTICE( [doxygen... enabled] ) dnl , dnl AC_MSG_NOTICE( [doxygen... disabled] ) dnl ) AS_IF([test "x$enable_doxygen" = "xyes"], [ dnl checks for doxygen program, sets or uses environment variable DOXYGEN AC_MSG_NOTICE([Checking for Doxygen...]) FLM_PROG_TRY_DOXYGEN AS_IF( [test -n $DOXYGEN], [ AC_MSG_NOTICE([Calling dx_init_doxygen...]) DX_PDF_FEATURE(ON) DX_HTML_FEATURE(ON) DX_INIT_DOXYGEN(ddcutil) AS_IF( [test 0$DBG -ne 0], [ AC_MSG_NOTICE([Set by dx_init_doxygen:]) AC_MSG_NOTICE([ DOXYGEN: $DOXYGEN ]) AC_MSG_NOTICE([ dx_DOT_FEATURE: $DX_DOT_FEATURE ]) AC_MSG_NOTICE([ dx_FEATURE_doc $DX_FEATURE_doc ]) AC_MSG_NOTICE([ dx_DOXYGEN_FEATURE: $DX_DOXYGEN_FEATURE ]) AC_MSG_NOTICE([ dx_HTML_FEATURE: $DX_HTML_FEATURE ]) AC_MSG_NOTICE([ dx_FLAG_html: $DX_FLAG_HTML ]) AC_MSG_NOTICE([ dx_PDF_FEATURE: $DX_PDF_FEATURE ]) AC_MSG_NOTICE([ DX_PROJECT: $DX_PROJECT ]) AC_MSG_NOTICE([ DX_CONFIG: $DX_CONFIG ]) AC_MSG_NOTICE([ DX_DOCDIR: $DX_DOCDIR ]) ]) AC_CONFIG_FILES( [docs/doxygen/doxyfile] ) ] , [ AC_MSG_NOTICE([doxygen not found]) enable_doxygen=no ] ) ] , [ AC_MSG_NOTICE([doxygen disabled, not checking for Doxygen]) ] ) dnl AC_MSG_NOTICE([enable_doxygen = ${enable_doxygen}]) dnl AM_CONDITIONAL( [HAVE_DOXYGEN], [test -n "$DOXYGEN"] ) dnl AM_CONDITIONAL( [USE_DOXYGEN], [test -n "$DOXYGEN" -a "x$enable_doxygen" = "xyes"]) AM_CONDITIONAL( [USE_DOXYGEN], [test "x$enable_doxygen" = "xyes"]) AM_COND_IF([USE_DOXYGEN], AC_MSG_NOTICE([USE_DOXYGEN is set]) , AC_MSG_NOTICE([USE_DOXYGEN not set]) ) ### DOC-BASE dnl n. doc-base is Debian specific dnl doc-base does not have pc file. AC_CHECK_PROGS( [DOCBASE_INSTALL_DOCS], [install-docs]) AS_IF( [test -n "$DOCBASE_INSTALL_DOCS"], AC_MSG_NOTICE([doc-base execuable found]) AC_CONFIG_FILES([docs/ddcutil-c-api]), AC_MSG_WARN([doc-base not installed - continuing without doc-base support]) ) AM_CONDITIONAL( [HAVE_DOCBASE], [test -n "$DOCBASE_INSTALL_DOCS"]) ### Library AS_IF([test "x$enable_lib" = "xyes"], [ PKG_CHECK_MODULES(ZLIB, zlib) ], ) AS_IF( [test "x$enable_asan" = "xyes"], [ required_packages="asan $required_packages" # has no effect on $CFLAGS CFLAGS="$CFLAGS -fsanitize=address" CFLAGS="$CFLAGS -fsanitize-address-use-after-scope -fno-omit-frame-pointer" ]) dnl AC_MSG_NOTICE([======================== required_packages: $required_packages]) AC_SUBST(REQUIRED_PACKAGES,$required_packages) ### Opsys variability dnl Fails: if building in OBS, SUSE is in /proc/version, even when building for Fedora dnl TODO: do not modify if explicitly set dnl AC_MSG_NOTICE([Original docdir: ${docdir}]) dnl AS_IF( [ grep SUSE /proc/version ], [ dnl AC_MSG_NOTICE( [IS SUSE]) dnl docdir=\${datarootdir}/doc/packages/\${PACKAGE_TARNAME} dnl ], [ dnl AC_MSG_NOTICE( [NOT SUSE] ) dnl ] ) dnl AC_MSG_NOTICE([======> Tests for SUSE target:]) dnl test using [ grep SUSE /proc/version ] dnl always tests true on OBS, i.e reports the OS on which the build system is running, not the target os dnl test using [ ls -d /usr/share/doc/packages ] dnl always tests true on OBS dnl test using [test "x$enable_force_suse" = "xyes"], i.e. enable-force_suse parm passed to configure dnl works dnl test using [ grep suse /etc/os-release ] dnl successfully detects target OS when run on OBS dnl test using [lsb-release -i | grep SUSE ] dnl on OBS, command not found AC_MSG_CHECKING( [target OS using /etc/os-release] ) AS_IF( [ grep suse /etc/os-release > /dev/null], [ AC_MSG_RESULT( [target is SUSE]) docdir=\${datarootdir}/doc/packages/\${PACKAGE_TARNAME} AC_MSG_NOTICE( [..Forcing docdir to ${docdir}] ) ], [ AC_MSG_RESULT( [target is not SUSE ] ) ] ) ### ### Generate output ### dnl called once at end of configure.ac, generates and runs config.status AC_OUTPUT dnl a brief summary AC_MSG_RESULT([ ddcutil $VERSION version suffix: ddcutil_version_suffix ============= libtool version ${LT_CURRENT}:${LT_REVISION}:${LT_AGE} prefix: ${prefix} exec_prefix: ${exec_prefix} libexecdir: ${libexecdir} bindir: ${bindir} libdir: ${libdir} datarootdir: ${datarootdir} datadir: ${datadir} docdir: ${docdir} mandir: ${mandir} includedir: ${includedir} pkgconfigdir: ${pkgconfigdir} required_packages: ${required_packages} enable_lib: ${enable_lib} enable_install_lib_only ${enable_install_lib_only} enable_build_timestamp ${enable_build_timestamp} enable_envcmds ${enable_envcmds} enable_udev ${enable_udev} enable_usb: ${enable_usb} enable_drm: ${enable_drm} enable_watch_displays: ${enable_watch_displays} enable_x11: ${enable_x11} dnl enable_trace: ${enable_trace} enable_asan: ${enable_asan} enable_static_functions_visible: ${enable_static_functions_visible} Developer-only options: enable_targetbsd: ${enable_targetbsd} enable_doxygen: ${enable_doxygen} enable_failsim: ${enable_failsim} include_testcases: ${include_testcases} compiler: ${CC} CFLAGS: ${CFLAGS} CPPFLAGS: ${CPPFLAGS} LDFLAGS: ${LDFLAGS} ]) dnl cat config.h rockowitz-ddcutil-7a384a9/data/000077500000000000000000000000001510573515300164535ustar00rootroot00000000000000rockowitz-ddcutil-7a384a9/data/Makefile.am000066400000000000000000000105221510573515300205070ustar00rootroot00000000000000# File data/Makefile.am # Copyright (C) 2016-2024 Sanford Rockowitz # SPDX-License-Identifier: GPL-2.0-or-later # The proper location for pkgconfig files is ambiguous, and the # subject of much discussion. . # However, it appears that: # - /usr/lib64/pkgconfig should hold x64 specific pkgconfig files # - /usr/lib/pkgconfig should hold i386 specific pkgconfig files # - /usr/share/pkgconfig should hold architecture agnostic pkgconfig files # # The tail wags the dog. libddcutil-dev can contain # usr/*/pkgconfig # or # usr/lib/x86_64-linux-gnu/pkgconfig # but there's no way to "or" these two statements. # # When building on OBS, the same libddcutil-dev.install is used for all (Debian based) builds, # and if using $(libdir) the location of ddcutil.pc will depend on platform, e.g. # some times it will be /usr/lib/x86_64-linux-gnu/pkgconfig, sometimes something else. # # Note the the entry for ddcutil.pc in the Debian .install file needs # to be kept in sync with where autotools puts the files. resfiles = \ etc/modprobe.d/nvidia-i2c.conf \ etc/udev/rules.d/60-ddcutil-i2c.rules \ etc/udev/rules.d/60-ddcutil-usb.rules \ etc/X11/xorg.conf.d/90-nvidia-i2c.conf rulesfiles = \ usr/lib/udev/rules.d/60-ddcutil-i2c.rules distributed_modulesfiles = \ usr/lib/modules-load.d/ddcutil.conf if !INSTALL_LIB_ONLY_COND installed_modulesfiles = \ usr/lib/modules-load.d/ddcutil.conf endif pkgconfigfiles = \ ddcutil.pc # Causes files (with directory structure) to be included in tarball: EXTRA_DIST = $(resfiles) $(rulesfiles) $(distributed_modulesfiles) ddcutil.pc.in # Target directory pkgconfigdir = ${libdir}/pkgconfig # Target directory (/usr/local/share/ddcutil/data or /usr/share/ddcutil/data): ddcutildir = $(datadir)/ddcutil/data resdir = $(datadir)/ddcutil/data # Causes files (w/o directory structure) to be installed in target directory: if !INSTALL_LIB_ONLY_COND ddcutil_DATA = $(resfiles) pkgconfig_DATA = ddcutil.pc endif # Use prefix instead of libdir here because it appears that # udev/rules.d is always a subdirectory of /usr/lib rulesdir = ${prefix}/lib/udev/rules.d if !INSTALL_LIB_ONLY_COND rules_DATA = $(rulesfiles) endif # Similar comment for modules-load.d installed_modulesdir = $(prefix)/lib/modules-load.d if !INSTALL_LIB_ONLY_COND installed_modules_DATA = $(installed_modulesfiles) endif # include FindDDCUtil.cmake in tarball: EXTRA_DIST += cmake/ddcutil/FindDDCUtil.cmake # where FindDDCUtil.cmake will installed: cmakedir = $(libdir)/cmake/ddcutil if ENABLE_SHARED_LIB_COND if !INSTALL_LIB_ONLY_COND # where make install finds FindDDCUtil.cmake: cmake_DATA = cmake/ddcutil/FindDDCUtil.cmake endif endif # n. -local executes before target, -hook executes after all-local: @echo "(data/Makefile) ==> Executing rule: all-local" install-data-local: @echo "(data/Makefile) ==> Executing rule: install-data-local" @echo "prefix: ${prefix}" @echo "includedir ${includedir}" @echo "docdir ${docdir}" @echo "libdir ${libdir}" @echo "rulesdir ${rulesdir}" @echo "packagedatadir: $(packagedatadir)" @echo "datadir: $(datadir)" @echo "ddcutildir: $(ddcutildir)" @echo "srcdir: $(srcdir)" @echo "bindir: ${bindir}" @echo "cmakedir: ${cmakedir}" @echo "DESTDIR: ${DESTDIR}" @echo "rulesfiles: ${rulesfiles}" @echo "resfiles: ${resfiles}" @echo "udevdir: ${udevdir}" # @xxx@ names are not defined, names with $() are # use "find ..." instead of "rm -f" as latter tries to delete directory as well # rm -f ${DESTDIR}${resdir}/45-ddcutil* # rm -f ${DESTDIR}${rulesdir}/60-ddcutil.rules # rm -f ${DESTDIR}${rulesdir}/60-ddcutil-usb.rules install-data-hook: @echo "(data/install-data-hook)===> Executing rule: install-data-hook" # if !INSTALL_LIB_ONLY_COND # sed -i "s|/usr|${prefix}|" ${DESTDIR}${rulesdir}/60-ddcutil-usb.rules # endif @echo "Clear out files possibly left over from earlier installation" find ${DESTDIR}${resdir} -name "45-ddcutil*" -delete find ${DESTDIR}${resdir} -name "60-ddcutil.rules" -delete uninstall-hook: @echo "(data/uninstall-hook)===> Executing rule: uninstall-hook" @echo "Clear out files possibly left over from earlier installation" find ${DESTDIR}${resdir} -name "45-ddcutil.rules" -delete find ${DESTDIR}${rulesdir} -name "60-ddcutil-usb.rules" -delete rockowitz-ddcutil-7a384a9/data/cmake/000077500000000000000000000000001510573515300175335ustar00rootroot00000000000000rockowitz-ddcutil-7a384a9/data/cmake/ddcutil/000077500000000000000000000000001510573515300211635ustar00rootroot00000000000000rockowitz-ddcutil-7a384a9/data/cmake/ddcutil/FindDDCUtil.cmake000066400000000000000000000047761510573515300242340ustar00rootroot00000000000000# - Try to find Libddcutil # Once done this will define # # DDCUTIL_FOUND - system has DDCUtil # DDCUTIL_INCLUDE_DIR - the libddcutil include directory # DDCUTIL_LIBS - The libddcutil libraries # Copyright (c) 2017, Dorian Vogel, # # Redistribution and use in source and binary forms, with or without # modification, are permitted provided that the following conditions # are met: # 1. Redistributions of source code must retain the above copyright # notice, this list of conditions and the following disclaimer. # 2. Redistributions in binary form must reproduce the above copyright # notice, this list of conditions and the following disclaimer in the # documentation and/or other materials provided with the distribution. # 3. Neither the name of the University nor the names of its contributors # may be used to endorse or promote products derived from this software # without specific prior written permission. # # THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND # ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE # IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE # ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE # FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL # DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS # OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) # HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT # LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY # OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF # SUCH DAMAGE. find_package(PkgConfig) pkg_check_modules(PC_LIBDDCUTIL QUIET ddcutil) set(LIBDDCUTIL_DEFINITIONS ${PC_LIBDDCUTIL_CFLAGS_OTHER}) find_path(LIBDDCUTIL_INCLUDE_DIR ddcutil_c_api.h HINTS ${PC_LIBDDCUTIL_INCLUDEDIR} ${PC_LIBDDCUTIL_INCLUDE_DIRS}) find_library(LIBDDCUTIL_LIBRARY NAMES libddcutil.so HINTS ${PC_LIBDDCUTIL_LIBDIR} ${PC_LIBDDCUTIL_LIBRARY_DIRS} ) include(FindPackageHandleStandardArgs) # handle the QUIETLY and REQUIRED arguments and set LIBDDCUTIL_FOUND to TRUE # if all listed variables are TRUE find_package_handle_standard_args(ddcutil DEFAULT_MSG LIBDDCUTIL_LIBRARY LIBDDCUTIL_INCLUDE_DIR) mark_as_advanced(LIBDDCUTIL_INCLUDE_DIR LIBDDCUTIL_LIBRARY ) set(LIBDDCUTIL_LIBRARIES ${LIBDDCUTIL_LIBRARY} ) set(LIBDDCUTIL_INCLUDE_DIRS ${LIBDDCUTIL_INCLUDE_DIR} ) rockowitz-ddcutil-7a384a9/data/ddcutil.pc.in000066400000000000000000000006111510573515300210320ustar00rootroot00000000000000prefix=@prefix@ exec_prefix=@exec_prefix@ libdir=@libdir@ includedir=@includedir@ Name: @PACKAGE@ Description: Control display settings URL: http://www.ddcutil.com Version: @VERSION@ # No. These are packages required by the library, not the caller # Requires: @REQUIRED_PACKAGES@ # Libs and Cflags not needed since using default locations Libs: -L${libdir} -lddcutil Cflags: -I${includedir} rockowitz-ddcutil-7a384a9/data/etc/000077500000000000000000000000001510573515300172265ustar00rootroot00000000000000rockowitz-ddcutil-7a384a9/data/etc/X11/000077500000000000000000000000001510573515300175775ustar00rootroot00000000000000rockowitz-ddcutil-7a384a9/data/etc/X11/xorg.conf.d/000077500000000000000000000000001510573515300217245ustar00rootroot00000000000000rockowitz-ddcutil-7a384a9/data/etc/X11/xorg.conf.d/90-nvidia-i2c.conf000066400000000000000000000006421510573515300247500ustar00rootroot00000000000000# xorg.conf.d file specifying proprietary Nvidia driver options often needed for DDC/CI Section "Device" Driver "nvidia" Identifier "Dev0" Option "RegistryDwords" "RMUseSwI2c=0x01; RMI2cSpeed=100" # solves problem of i2c errors with nvidia driver # per https://devtalk.nvidia.com/default/topic/572292/-solved-does-gddccontrol-work-for-anyone-here-nvidia-i2c-monitor-display-ddc/#4309293 EndSection rockowitz-ddcutil-7a384a9/data/etc/modprobe.d/000077500000000000000000000000001510573515300212575ustar00rootroot00000000000000rockowitz-ddcutil-7a384a9/data/etc/modprobe.d/nvidia-i2c.conf000066400000000000000000000002271510573515300240540ustar00rootroot00000000000000# modprobe.d file to set proprietary Nvidia driver options often needed for DDC/CI options nvidia NVreg_RegistryDwords=RMUseSwI2c=0x01;RMI2cSpeed=100 rockowitz-ddcutil-7a384a9/data/etc/udev/000077500000000000000000000000001510573515300201715ustar00rootroot00000000000000rockowitz-ddcutil-7a384a9/data/etc/udev/rules.d/000077500000000000000000000000001510573515300215455ustar00rootroot00000000000000rockowitz-ddcutil-7a384a9/data/etc/udev/rules.d/60-ddcutil-i2c.rules000066400000000000000000000017621510573515300251550ustar00rootroot00000000000000# Sample rules to grant RW access to /dev/i2c devices. # This sample file can be modified and copied to /etc/udev/rules.d. If file # /etc/udev/rules.d/60-ddcutil-i2c.rules exists, it overrides a file with the # same name in /usr/lib/udev/rules.d, which is created by ddcutil installation. # This can be useful in cases where the usual rules do not work as needed, or # during development. # The usual case, using TAG+="uaccess": If a /dev/i2c device is associated # with a video adapter, grant the current user access to it. # SUBSYSTEM=="i2c-dev", KERNEL=="i2c-[0-9]*", ATTRS{class}=="0x030000", TAG+="uaccess" # Assigns i2c devices to group i2c, and gives that group RW access. # Individual users must then be assigned to group i2c. # On some distributions, installing package i2c-tools creates this rule. # (For example, on Ubuntu, see 40-i2c-tools.rules.) # KERNEL=="i2c-[0-9]*", GROUP="i2c", MODE="0660" # Gives everyone RW access to the /dev/i2c devices: # KERNEL=="i2c-[0-9]*", MODE="0666" rockowitz-ddcutil-7a384a9/data/etc/udev/rules.d/60-ddcutil-usb.rules000066400000000000000000000025011510573515300252610ustar00rootroot00000000000000# Rules for monitors implementing USB communication with their Virtual Control Panel. # This sample file can be modified and copied to /etc/udev/rules.d. # If file /etc/udev/rules.d/60-ddcutil-usb.rules exists, it overrides a file with # the same name in /usr/lib/udev/rules.d. (This file used to be created by ddcutil # installation.) # The simplest solution is to specify a particular monitor device by its vid/pid, # and then use TAG+="uaccess" to grant the current user read/write access to it. # The values in this example are for an Apple Cinema Display, model A1082: # SUBSYSTEM=="usbmisc", ATTRS{idVendor}=="05ac", ATTRS{idProduct}=="9223", TAG+="uaccess" # A more general solution is to use ddcutil chkusbmon to check if a USB Human # Interface device implements the USB Device Class Definition for Human Interface # Devices. Unfortunately, this has been seen to cause system instability in # certain ill-defined cases. # Note this rule may have to be adjusted to reflect the actual path where # ddcutil is installed. The -v option produces informational messages. # These are lost when the rule is normally executed by udev, but can be # helpful when rules are tested using the "udevadm test" command. # SUBSYSTEM=="usbmisc", KERNEL=="hiddev*", PROGRAM="/usr/bin/ddcutil chkusbmon $env{DEVNAME} -v", TAG+="uaccess" rockowitz-ddcutil-7a384a9/data/usr/000077500000000000000000000000001510573515300172645ustar00rootroot00000000000000rockowitz-ddcutil-7a384a9/data/usr/lib/000077500000000000000000000000001510573515300200325ustar00rootroot00000000000000rockowitz-ddcutil-7a384a9/data/usr/lib/modules-load.d/000077500000000000000000000000001510573515300226415ustar00rootroot00000000000000rockowitz-ddcutil-7a384a9/data/usr/lib/modules-load.d/ddcutil.conf000066400000000000000000000000101510573515300251270ustar00rootroot00000000000000i2c-dev rockowitz-ddcutil-7a384a9/data/usr/lib/udev/000077500000000000000000000000001510573515300207755ustar00rootroot00000000000000rockowitz-ddcutil-7a384a9/data/usr/lib/udev/rules.d/000077500000000000000000000000001510573515300223515ustar00rootroot00000000000000rockowitz-ddcutil-7a384a9/data/usr/lib/udev/rules.d/60-ddcutil-i2c.rules000066400000000000000000000002101510573515300257440ustar00rootroot00000000000000SUBSYSTEM=="i2c-dev", KERNEL=="i2c-[0-9]*", ATTRS{class}=="0x03*", TAG+="uaccess" SUBSYSTEM=="dri",KERNEL=="card[0-9]*", TAG+="uaccess" rockowitz-ddcutil-7a384a9/ddcutil.appdata.xml000066400000000000000000000171611510573515300213330ustar00rootroot00000000000000 CC0-1.0 com.ddcutil.ddcutil ddcutil GPL-2.0-or-later Command line program to control monitor settings

ddcutil is a command line program for querying and changing monitor settings, such as brightness color levels, and power on hours. Most mointors, other than lapdop displays, have a Virtual Control Panel (VCP), which implements features defined in the Montor Control Command Set (MCCS) specification. Typically, ddcutil communicates with the monitor's VCP over an I2C bus, as per the Display Data Channel/Command Interface Standard (DDC/CI).

The corresponding desktop application is ddcui.

 ddcutil https://www.ddcutil.com/images/ddcutil_screenshot1.jpg Get all settings for a monitor ddcutil.desktop rockowitz@minsoft.com> https://www.ddcutil.com https://github.com/rockowitz/ddcutil/issues https://www.ddcutil.com/faq Sanford Rockowitz utilities-terminal system-run rockowitz-ddcutil-7a384a9/docs/000077500000000000000000000000001510573515300164725ustar00rootroot00000000000000rockowitz-ddcutil-7a384a9/docs/Makefile.am000066400000000000000000000012051510573515300205240ustar00rootroot00000000000000 SUBDIRS = # SUBDIRS += ddcutil if USE_DOXYGEN SUBDIRS += doxygen endif if USE_DOXYGEN if HAVE_DOCBASE docbasedir = $(datadir)/doc-base docbase_DATA = ddcutil-c-api EXTRA_DIST = ddcutil-c-api install-data-local: @echo "(docs/Makefile) Executing rule install-data-local" install-data-hook: @echo "(docs/Makefile) Executing rule install-data-hook" @echo "docbasedir $(docbasedir)" @echo "datadir $(datadir)" install-docs --install-changed # uninstall-data-hook doesn't exist, use uninstall-hook: uninstall-hook: @echo "(docs/Makefile) Executing rule uninstall-data-hook" install-docs --install-changed endif endif rockowitz-ddcutil-7a384a9/docs/ddcutil-c-api.in000066400000000000000000000005561510573515300214470ustar00rootroot00000000000000Document: ddcutil-c-api Title: ddcutil C API Author: Sanford Rockowitz Abstract: This doxgygen generated manual documents the ddcutil C API. You're probably better off just looking at the header files and sample code. Section: System/Hardware Format: HTML Index: @prefix@/share/doc/ddcutil/html/index.html Files: @prefix@/share/doc/ddcutil/html/* rockowitz-ddcutil-7a384a9/docs/doxygen/000077500000000000000000000000001510573515300201475ustar00rootroot00000000000000rockowitz-ddcutil-7a384a9/docs/doxygen/Makefile.am000066400000000000000000000006521510573515300222060ustar00rootroot00000000000000docpkg = $(PACKAGE_TARNAME)-doxy-$(PACKAGE_VERSION).tar.gz doc_DATA = $(docpkg) $(docpkg): doxygen.stamp tar chof - html | gzip -9 -c >$@ doxygen.stamp: doxyfile $(DOXYGEN) $(DOXYFLAGS) $< echo Timestamp > $@ install-data-hook: cd $(DESTDIR)$(docdir) && tar xf $(docpkg) uninstall-hook: cd $(DESTDIR)$(docdir) && rm -rf html CLEANFILES = doxywarn.txt doxygen.stamp $(docpkg) clean-local: rm -rf html rockowitz-ddcutil-7a384a9/docs/doxygen/doxyfile.in000066400000000000000000001671431510573515300223360ustar00rootroot00000000000000# Doxyfile 1.5.6 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project # # All text after a 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. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. PROJECT_NAME = @PACKAGE_NAME@ # 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 = @PACKAGE_VERSION@ # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. # 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 = . # 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 cause performance problems for the file system. CREATE_SUBDIRS = 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. # The default language is English, other supported languages are: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, # Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, # Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), # Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, # Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, # and Ukrainian. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES (the default) 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. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES (the default) 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. 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" "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. 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. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES then 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. FULL_PATH_NAMES = NO # If the FULL_PATH_NAMES tag is set to YES then 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. STRIP_FROM_PATH = @top_srcdir@ # 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 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. 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 # comments will behave just like regular Qt-style comments # (thus requiring an explicit @brief command for a brief description.) JAVADOC_AUTOBRIEF = YES # 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 comments # will behave just like regular Qt-style comments (thus requiring # an explicit \brief command for a brief description.) 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 behaviour. # 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 behaviour instead. MULTILINE_CPP_IS_BRIEF = NO # If the DETAILS_AT_TOP tag is set to YES then Doxygen # will output the detailed description near the top, like JavaDoc. # If set to NO, the detailed description appears after the member # documentation. # DETAILS_AT_TOP = NO # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented # member inherits the documentation from any documented member that it # re-implements. 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. 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. TAB_SIZE = 3 # This tag can be used to specify a number of aliases that acts # 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 = # 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. # OPTIMIZE_OUTPUT_FOR_C = NO OPTIMIZE_OUTPUT_FOR_C = YES # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java # sources only. Doxygen will then generate output that is more tailored for # Java. For instance, namespaces will be presented as packages, qualified # scopes will look different, etc. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources only. Doxygen will then generate output that is more tailored for # Fortran. 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. OPTIMIZE_OUTPUT_VHDL = NO # 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); v.s. # func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. BUILTIN_STL_SUPPORT = NO # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip 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. 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 (the default) # 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. 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. DISTRIBUTE_GROUP_DOC = NO # Set the SUBGROUPING tag to YES (the default) 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. SUBGROUPING = YES # When TYPEDEF_HIDES_STRUCT 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. TYPEDEF_HIDES_STRUCT = NO #--------------------------------------------------------------------------- # 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 and EXTRACT_STATIC tags are set to YES # EXTRACT_ALL = NO EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. EXTRACT_PRIVATE = NO # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. 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. EXTRACT_LOCAL_CLASSES = YES # This flag is only useful for Objective-C code. When 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 (the default) only methods in the interface are included. 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. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all # undocumented members of documented classes, files or namespaces. # If set to NO (the default) 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. HIDE_UNDOC_MEMBERS = YES # 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 (the default) these classes will be included in the various # overviews. This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_CLASSES = YES # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all # friend (class|struct|union) declarations. # If set to NO (the default) these declarations will be included in the # documentation. 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 (the default) these blocks will be appended to the # function's detailed documentation block. 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 (the default) then the documentation will be excluded. # Set it to YES to include the internal documentation. 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. CASE_SENSE_NAMES = NO # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen # will show members with their full class and namespace scopes in the # documentation. If set to YES the scope will be hidden. HIDE_SCOPE_NAMES = NO # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen # will put a list of the files that are included by a file in the documentation # of that file. SHOW_INCLUDE_FILES = YES # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES (the default) 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. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the # brief documentation of file, namespace and class members alphabetically # by member name. If set to NO (the default) the members will appear in # declaration order. SORT_BRIEF_DOCS = 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 default) # the group names will appear in their defined order. 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 default), 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. SORT_BY_SCOPE_NAME = 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. 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. 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. 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. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines # the initial value of a variable or define consists of 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 initializer of individual variables and defines in the # documentation can be controlled using \showinitializer or \hideinitializer # command in the documentation regardless of this setting. 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. # SHOW_USED_FILES = NO SHOW_USED_FILES = YES # If the sources in your project are distributed over multiple directories # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy # in the documentation. The default is NO. # *** OBSOLETE *** # SHOW_DIRECTORIES = NO # 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 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 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 , where is the value of # the FILE_VERSION_FILTER tag, and is the name of an input file # provided by doxygen. Whatever the program writes to standard output # is used as the file version. See the manual for examples. FILE_VERSION_FILTER = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. Possible values are YES and NO. If left blank NO is used. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated by doxygen. Possible values are YES and NO. If left blank # NO is used. WARNINGS = YES # If WARN_IF_UNDOCUMENTED 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. WARN_IF_UNDOCUMENTED = YES # If WARN_IF_DOC_ERROR 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. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be abled to get warnings for # functions that are documented, but have no documentation for their parameters # or return value. If set to NO (the default) doxygen will only warn about # wrong or incomplete parameter documentation, but not about the absence of # documentation. # WARN_NO_PARAMDOC = NO WARN_NO_PARAMDOC = YES # 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) 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 stderr. WARN_LOGFILE = doxywarn.txt #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag can be 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. INPUT = @top_srcdir@/src/public/ddcutil_c_api.h @top_srcdir@/src/public/ddcutil_types.h # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is # also the default input encoding. 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. 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 pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank the following patterns are tested: # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 FILE_PATTERNS = *.c \ *.cc \ *.cxx \ *.cpp \ *.c++ \ *.d \ *.java \ *.ii \ *.ixx \ *.ipp \ *.i++ \ *.inl \ *.h \ *.hh \ *.hxx \ *.hpp \ *.h++ \ *.idl \ *.odl \ *.cs \ *.php \ *.php3 \ *.inc \ *.m \ *.mm \ *.dox \ *.py # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. # If left blank NO is used. RECURSIVE = NO # The EXCLUDE tag can be used to specify files and/or directories that should # 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. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded # from the input. 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 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. # Possible values are YES and NO. If left blank NO is used. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or # directories that contain image that are 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. 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 # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER # is applied to all files. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will be used to filter the input files when producing source # files to browse (i.e. when SOURCE_BROWSER is set to YES). FILTER_SOURCE_FILES = NO #--------------------------------------------------------------------------- # 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 also # VERBATIM_HEADERS is set to NO. SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body # of functions and classes directly in the documentation. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct # doxygen to hide any special comment blocks from generated source code # fragments. Normal C and C++ comments will always remain visible. 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. 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. REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) # 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 documentstion. REFERENCES_LINK_SOURCE = 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. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set to YES (the default) 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. VERBATIM_HEADERS = NO #--------------------------------------------------------------------------- # 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. ALPHABETICAL_INDEX = YES # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns # in which this list will be split (can be a number in the range [1..20]) 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 one or more prefixes that # should be ignored while generating the index headers. IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES (the default) Doxygen will # generate HTML output. 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. If left blank `html' will be used as the default path. 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). If it is left blank # doxygen will generate files with .html extension. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a personal HTML header for # each generated HTML page. If it is left blank doxygen will generate a # standard header. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a personal HTML footer for # each generated HTML page. If it is left blank doxygen will generate a # standard footer. 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 the tag is left blank doxygen # will generate a default style sheet. Note that doxygen will try to copy # the style sheet file to the HTML output directory, so don't put your own # stylesheet in the HTML output directory as well, or it will be erased! HTML_STYLESHEET = # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, # files or namespaces will be aligned in HTML using tables. If set to # NO a bullet list will be used. # *** OBSOLETE *** # HTML_ALIGN_MEMBERS = YES # If the GENERATE_HTMLHELP tag is set to YES, additional index files # will be generated that can be used as input for tools like the # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) # of the generated HTML documentation. GENERATE_HTMLHELP = NO # 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, 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. GENERATE_DOCSET = NO # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the # 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. DOCSET_FEEDNAME = "Doxygen generated docs" # When GENERATE_DOCSET tag is set to YES, 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. DOCSET_BUNDLE_ID = org.doxygen.Project # 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. For this to work a browser that supports # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). HTML_DYNAMIC_SECTIONS = NO # If the GENERATE_HTMLHELP tag is set to YES, 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. CHM_FILE = # If the GENERATE_HTMLHELP tag is set to YES, 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. HHC_LOCATION = # If the GENERATE_HTMLHELP tag is set to YES, 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). GENERATE_CHI = NO # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING # is used to encode HtmlHelp index (hhk), content (hhc) and project file # content. CHM_INDEX_ENCODING = # If the GENERATE_HTMLHELP tag is set to YES, 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. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members # to the contents of the HTML help documentation and to the tree view. TOC_EXPAND = NO # The DISABLE_INDEX tag can be used to turn on/off the condensed index at # top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. DISABLE_INDEX = NO # This tag can be used to set the number of enum values (range [1..20]) # that doxygen will group on one line in the generated HTML documentation. ENUM_VALUES_PER_LINE = 4 # 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 FRAME, 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 (for instance Mozilla 1.0+, # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are # probably better off using the HTML help feature. Other possible values # for this tag are: HIERARCHIES, which will generate the Groups, Directories, # and Class Hiererachy pages using a tree view instead of an ordered list; # ALL, which combines the behavior of FRAME and HIERARCHIES; and NONE, which # disables this behavior completely. For backwards compatibility with previous # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE # respectively. GENERATE_TREEVIEW = YES # 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. TREEVIEW_WIDTH = 250 # Use this tag to change the font size of Latex formulas included # as images in the HTML documentation. The default is 10. Note that # 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. FORMULA_FONTSIZE = 10 #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. # GENERATE_LATEX = NO GENERATE_LATEX = YES # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `latex' will be used as the default path. LATEX_OUTPUT = latex # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. If left blank `latex' will be used as the default command name. LATEX_CMD_NAME = latex # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to # generate index for LaTeX. If left blank `makeindex' will be used as the # default command name. MAKEINDEX_CMD_NAME = makeindex # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact # LaTeX documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_LATEX = NO # The PAPER_TYPE tag can be used to set the paper type that is used # by the printer. Possible values are: a4, a4wide, letter, legal and # executive. If left blank a4wide will be used. PAPER_TYPE = a4wide # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # packages that should be included in the LaTeX output. EXTRA_PACKAGES = # The LATEX_HEADER tag can be used to specify a personal LaTeX header for # the generated latex document. The header should contain everything until # the first chapter. If it is left blank doxygen will generate a # standard header. Notice: only use this tag if you know what you are doing! LATEX_HEADER = # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated # is prepared for conversion to pdf (using ps2pdf). The pdf file will # contain links (just like the HTML output) instead of page references # This makes the output suitable for online browsing using a pdf viewer. # PDF_HYPERLINKS = NO PDF_HYPERLINKS = YES # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of # plain latex in the generated Makefile. Set this option to YES to get a # higher quality PDF documentation. # USE_PDFLATEX = NO USE_PDFLATEX = YES # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. # command to the generated LaTeX files. This will instruct LaTeX to keep # running if errors occur, instead of asking the user for help. # This option is also used when generating formulas in HTML. LATEX_BATCHMODE = NO # If LATEX_HIDE_INDICES is set to YES then doxygen will not # include the index chapters (such as File Index, Compound Index, etc.) # in the output. LATEX_HIDE_INDICES = NO #--------------------------------------------------------------------------- # configuration options related to the RTF output #--------------------------------------------------------------------------- # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output # The RTF output is optimized for Word 97 and may not look very pretty with # other RTF readers or editors. GENERATE_RTF = NO # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `rtf' will be used as the default path. RTF_OUTPUT = rtf # If the COMPACT_RTF tag is set to YES Doxygen generates more compact # RTF documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_RTF = NO # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated # will contain hyperlink fields. The RTF file will # contain links (just like the HTML output) instead of page references. # This makes the output suitable for online browsing using WORD or other # programs which support those fields. # Note: wordpad (write) and others do not support links. RTF_HYPERLINKS = NO # Load stylesheet definitions from file. Syntax is similar to doxygen's # config file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. RTF_STYLESHEET_FILE = # Set optional variables used in the generation of an rtf document. # Syntax is similar to doxygen's config file. RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- # If the GENERATE_MAN tag is set to YES (the default) Doxygen will # generate man pages GENERATE_MAN = NO # The MAN_OUTPUT tag is used to specify where the man pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `man' will be used as the default path. MAN_OUTPUT = man # The MAN_EXTENSION tag determines the extension that is added to # the generated man pages (default is the subroutine's section .3) MAN_EXTENSION = .3 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, # then it will generate one additional man file for each entity # documented in the real man page(s). These additional files # only source the real man page, but without them the man command # would be unable to find the correct page. The default is NO. MAN_LINKS = NO #--------------------------------------------------------------------------- # configuration options related to the XML output #--------------------------------------------------------------------------- # If the GENERATE_XML tag is set to YES Doxygen will # generate an XML file that captures the structure of # the code including all documentation. GENERATE_XML = NO # The XML_OUTPUT tag is used to specify where the XML pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `xml' will be used as the default path. XML_OUTPUT = xml # The XML_SCHEMA tag can be used to specify an XML schema, # which can be used by a validating XML parser to check the # syntax of the XML files. # *** OBSOLETE *** # XML_SCHEMA = # The XML_DTD tag can be used to specify an XML DTD, # which can be used by a validating XML parser to check the # syntax of the XML files. # *** OBSOLETE *** # XML_DTD = # If the XML_PROGRAMLISTING tag is set to YES Doxygen will # dump the program listings (including syntax highlighting # and cross-referencing information) to the XML output. Note that # enabling this will significantly increase the size of the XML output. XML_PROGRAMLISTING = YES #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will # generate an AutoGen Definitions (see autogen.sf.net) file # that captures the structure of the code including all # documentation. Note that this feature is still experimental # and incomplete at the moment. GENERATE_AUTOGEN_DEF = NO #--------------------------------------------------------------------------- # configuration options related to the Perl module output #--------------------------------------------------------------------------- # If the GENERATE_PERLMOD tag is set to YES Doxygen will # generate a Perl module file that captures the structure of # the code including all documentation. Note that this # feature is still experimental and incomplete at the # moment. GENERATE_PERLMOD = NO # If the PERLMOD_LATEX tag is set to YES Doxygen will generate # the necessary Makefile rules, Perl scripts and LaTeX code to be able # to generate PDF and DVI output from the Perl module output. PERLMOD_LATEX = NO # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be # nicely formatted so it can be parsed by a human reader. This is useful # if you want to understand what is going on. On the other hand, if this # tag is set to NO the size of the Perl module output will be much smaller # and Perl will parse it just the same. PERLMOD_PRETTY = YES # The names of the make variables in the generated doxyrules.make file # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. # This is useful so different doxyrules.make files included by the same # Makefile don't overwrite each other's variables. PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the preprocessor #--------------------------------------------------------------------------- # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will # evaluate all C-preprocessor directives found in the sources and include # files. ENABLE_PREPROCESSING = YES # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro # names in the source code. If set to NO (the default) only conditional # compilation will be performed. Macro expansion can be done in a controlled # way by setting EXPAND_ONLY_PREDEF to YES. MACRO_EXPANSION = NO # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES # then the macro expansion is limited to the macros specified with the # PREDEFINED and EXPAND_AS_DEFINED tags. EXPAND_ONLY_PREDEF = NO # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files # in the INCLUDE_PATH (see below) will be search if a #include is found. SEARCH_INCLUDES = YES # The INCLUDE_PATH tag can be used to specify one or more directories that # contain include files that are not input files but should be processed by # the preprocessor. INCLUDE_PATH = # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard # patterns (like *.h and *.hpp) to filter out the header-files in the # directories. If left blank, the patterns specified with FILE_PATTERNS will # be used. INCLUDE_FILE_PATTERNS = # The PREDEFINED tag can be used to specify one or more macro names that # are defined before the preprocessor is started (similar to the -D option of # gcc). The argument of the tag is a list of macros of the form: name # or name=definition (no spaces). If the definition and the = are # omitted =1 is assumed. To prevent a macro definition from being # undefined via #undef or recursively expanded use the := operator # instead of the = operator. PREDEFINED = # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded. # The macro definition that is found in the sources will be used. # Use the PREDEFINED tag if you want to use a different macro definition. EXPAND_AS_DEFINED = # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then # doxygen's preprocessor will remove all function-like macros that are alone # on a line, have an all uppercase name, and do not end with a semicolon. Such # function macros are typically used for boiler-plate code, and will confuse # the parser if not removed. SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- # Configuration::additions related to external references #--------------------------------------------------------------------------- # The TAGFILES option can be used to specify one or more tagfiles. # Optionally an initial location of the external documentation # can be added for each tagfile. The format of a tag file without # this location is as follows: # TAGFILES = file1 file2 ... # Adding location for the tag files is done as follows: # TAGFILES = file1=loc1 "file2 = loc2" ... # where "loc1" and "loc2" can be relative or absolute paths or # URLs. If a location is present for each tag, the installdox tool # does not have to be run to correct the links. # Note that each tag file must have a unique name # (where the name does NOT include the path) # If a tag file is not located in the directory in which doxygen # is run, you must also specify the path to the tagfile here. TAGFILES = # When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. GENERATE_TAGFILE = # If the ALLEXTERNALS tag is set to YES all external classes will be listed # in the class index. If set to NO only the inherited external classes # will be listed. ALLEXTERNALS = NO # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed # in the modules index. If set to NO, only the current project's groups will # be listed. EXTERNAL_GROUPS = YES # The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of `which perl'). PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base # or super classes. Setting the tag to NO turns the diagrams off. Note that # this option is superseded by the HAVE_DOT option below. This is only a # fallback. It is recommended to install and use dot, since it yields more # powerful graphs. CLASS_DIAGRAMS = YES # You can define message sequence charts within doxygen comments using the \msc # command. Doxygen will then run the mscgen tool (see # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the # documentation. The MSCGEN_PATH tag allows you to specify the directory where # the mscgen tool resides. If left empty the tool is assumed to be found in the # default search path. MSCGEN_PATH = # If set to YES, the inheritance and collaboration graphs will hide # inheritance and usage relations if the target is undocumented # or is not a class. HIDE_UNDOC_RELATIONS = YES # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is # available from the path. This tool is part of Graphviz, a graph visualization # toolkit from AT&T and Lucent Bell Labs. The other options in this section # have no effect if this option is set to NO (the default) HAVE_DOT = NO # By default doxygen will write a font called FreeSans.ttf to the output # directory and reference it in all dot files that doxygen generates. This # font does not include all possible unicode characters however, so when you need # these (or just want a differently looking font) you can specify the font name # using DOT_FONTNAME. You need need to make sure dot is able to find the font, # which can be done by putting it in a standard location or by setting the # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory # containing the font. DOT_FONTNAME = FreeSans # By default doxygen will tell dot to use the output directory to look for the # FreeSans.ttf font (which doxygen will put there itself). If you specify a # different font using DOT_FONTNAME you can set the path where dot # can find it using this tag. DOT_FONTPATH = # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect inheritance relations. Setting this tag to YES will force the # the CLASS_DIAGRAMS tag to NO. CLASS_GRAPH = YES # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect implementation dependencies (inheritance, containment, and # class references variables) of the class with other documented classes. COLLABORATION_GRAPH = YES # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen # will generate a graph for groups, showing the direct groups dependencies GROUP_GRAPHS = YES # If the UML_LOOK tag is set to YES doxygen will generate inheritance and # collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. UML_LOOK = NO # If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances. TEMPLATE_RELATIONS = NO # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT # tags are set to YES then doxygen will generate a graph for each documented # file showing the direct and indirect include dependencies of the file with # other documented files. INCLUDE_GRAPH = YES # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and # HAVE_DOT tags are set to YES then doxygen will generate a graph for each # documented header file showing the documented files that directly or # indirectly include this file. INCLUDED_BY_GRAPH = YES # If the CALL_GRAPH and HAVE_DOT options are set to YES then # doxygen will generate a call dependency graph for every global function # or class method. Note that enabling this option will significantly increase # the time of a run. So in most cases it will be better to enable call graphs # for selected functions only using the \callgraph command. CALL_GRAPH = NO # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then # doxygen will generate a caller dependency graph for every global function # or class method. Note that enabling this option will significantly increase # the time of a run. So in most cases it will be better to enable caller # graphs for selected functions only using the \callergraph command. CALLER_GRAPH = NO # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # will graphical hierarchy of all classes instead of a textual one. GRAPHICAL_HIERARCHY = YES # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES # then doxygen will show the dependencies a directory has on other directories # in a graphical way. The dependency relations are determined by the #include # relations between the files in the directories. DIRECTORY_GRAPH = YES # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. Possible values are png, jpg, or gif # If left blank png will be used. DOT_IMAGE_FORMAT = png # The tag DOT_PATH can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found in the path. DOT_PATH = # The DOTFILE_DIRS tag can be used to specify one or more directories that # contain dot files that are included in the documentation (see the # \dotfile command). DOTFILE_DIRS = # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of # nodes that will be shown in the graph. If the number of nodes in a graph # becomes larger than this value, doxygen will truncate the graph, which is # visualized by representing a node as a red box. Note that doxygen if the # number of direct children of the root node in a graph is already larger than # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. DOT_GRAPH_MAX_NODES = 50 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the # graphs generated by dot. A depth value of 3 means that only nodes reachable # from the root by following a path via at most 3 edges will be shown. Nodes # that lay further from the root node will be omitted. Note that setting this # option to 1 or 2 may greatly reduce the computation time needed for large # code bases. Also note that the size of a graph can be further restricted by # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. MAX_DOT_GRAPH_DEPTH = 1000 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent # background. This is enabled by default, which results in a transparent # background. Warning: Depending on the platform used, enabling this option # may lead to badly anti-aliased labels on the edges of a graph (i.e. they # become hard to read). DOT_TRANSPARENT = NO # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This # makes dot run faster, but since only newer versions of dot (>1.8.10) # support this, this feature is disabled by default. DOT_MULTI_TARGETS = NO # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will # generate a legend page explaining the meaning of the various boxes and # arrows in the dot generated graphs. GENERATE_LEGEND = YES # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will # remove the intermediate dot files that are used to generate # the various graphs. DOT_CLEANUP = YES #--------------------------------------------------------------------------- # Configuration::additions related to the search engine #--------------------------------------------------------------------------- # The SEARCHENGINE tag specifies whether or not a search engine should be # used. If set to NO the values of all tags below this one will be ignored. SEARCHENGINE = NO rockowitz-ddcutil-7a384a9/doxydoc/000077500000000000000000000000001510573515300172135ustar00rootroot00000000000000rockowitz-ddcutil-7a384a9/doxydoc/api.doxyfile000066400000000000000000003147021510573515300215400ustar00rootroot00000000000000# 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 = "ddcutil C API" # 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 = Control Monitor Settings # 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 = apidoc # 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 = # 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 = YES # 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 # FULL_PATH_NAMES = NO # 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 = /shared/playproj/i2c/src # 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 = YES # 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 = YES # 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 = YES # 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 TYPEDEF_HIDES_STRUCT = YES # 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 = YES # 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 = YES # 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 = YES # 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 WARN_AS_ERROR = YES # 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 = \ /shared/playproj/i2c/src/public # 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 = # 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 = internals_mainpage.md #--------------------------------------------------------------------------- # 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 = YES # 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 = YES # 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 = YES # 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 = NO # 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 GENERATE_ECLIPSEHELP = YES # 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 = com.minsoft.ddcutil.util # 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 # , /