mirror of
https://github.com/Llewellynvdm/conky.git
synced 2025-02-12 00:48:49 +00:00
8aa9c819f3
* Try to amend #31 * BUILD_WLAN should be available for all OS. Keep BUILD_WLAN OFF by default for compatibility reasons. * WLAN-related variables should be available for every OS. There are some problems (probably null-dereference) * Fix $wireless_essid crashing conky if no argument provided. Conky wasn't parsing the argument of the variable as it should, thus wasn't allocating the `dev` member variable. Also fix some documentation stuff. * Improve `get_freq` #20 Using the Intel® Power Gadget API (https://software.intel.com/en-us/blogs/2012/12/13/using-the-intel-power-gadget-api-on-mac-os-x) we can now get actual Core frequency and not the constant factory one. Though, for some weird reason the API gives the same freq for all Cores, thus the |cpu| arg becomes useless. * Oops, this accidently slipped in * Introduce BUILD_IPGFREQ build option This build option has been introduced for one particular reason: On macOS getting current core-frequency is not supported by the APIs. A solution is to install Intel's ® Power Gadget which comes with an .app, a Framework and a kernel-extension. Though, this may trouble some alot, thus introduce BUILD_IPGFREQ. * Forgot static here. * Some improvements for get_freq again. Fix frequency not printing correctly (I wasn't using the divisor) Add more guards. * Setup cmake files and project code for Objective-C code #17 We want to use CoreWLAN framework. * update_cpu_usage() now supports multiple cores Also, some cleanup. * Updated default conky config to monitor Mac Networking * Made Mac Friendly BuildOptions and generic default conky configs * Undid Xdamage config and cleaned up previous IF statements * Re-Added XDamage fix * Finish up the algorithm. I think its now correct. Closes: #33 * Cleanup macro and introduce a no-op free_cpu() function for ALL cpu-related variables free_cpu() must be implemented for every OS and on all except macOS its a no-op function. * Reformat, add empty comment.
DA DOCS. YO. ============ The main file that contains the bulk of our documentation is docs.xml . We use the DocBook format, which is a really kickass xml-based way of writing documentation, heavily oriented towards programming and computer stuff. There are tags like <command> and <option> that marks up your content without actually having to mark it up, which is why something that's of the <command> shows up in some cool style regardless of whether it's in a man page or a web page. DocBook has been around for 10 years, and there's TONS of resources online about the different tags and the stuff that can be done. FILE ORGANIZATION ================= For the sake of making things readable and organized, docs.xml "includes" three other files, as of 8/18/05. These are config_settings.xml, command_options.xml, and variables.xml . Their names are pretty self-explanatory, and what the "include" essentially does is stick their contents into docs.xml at the appropriate locations when it's time to produce a man page or html file. So if you wanted to add a variable or explain a command line option better, you'd look in variables.xml and command_options.xml. If you wanted to change the authors or something, look in docs.xml BUILDING DA DOCS ================ (NOTE that the docs are now built automatically via doc/Makefile.am, but it requires that you have docbook2x and xsltproc installed) making the html is easy. xsltproc should more than likely already be on your system: xsltproc http://docbook.sourceforge.net/release/xsl/current/html/docbook.xsl docs.xml > docs.html ============================================================================================================== making the man page is pretty easy, it uses a program called docbook2x, which you might or might not have. docbook2x-man docs.xml (produces a conky.1 file) gzip conky.1 conky.1.gz can be viewed in man-form by doing "man -l conky.1.gz" ============================================================================================================== making the README (text-only) file is just some simple unix: man -l conky.1.gz | col -b > README