mirror of
https://github.com/Llewellynvdm/conky.git
synced 2024-12-27 12:42:41 +00:00
3753e2a95b
* nvidia: Update the docs and add more arguments **Updated the docs in variables.xml to reflect the current nvidia object.** Basically just copied the inline comments into the XML document **Added the last of the compatible arguments** The following arguments were added to `get_nvidia_barval`: * memfree * ambienttemp * gpufreq * memfreq * mtrfreq * imagequality This should leave only incompatible arguments unsupported (e.g. min/max values). Decided to base percentages off of zero rather than the specified minimum values. Signed-off-by: Matt Sturgeon <matt@sturgeon.me.uk> * nvidia: Better error/debug printing * Merged `scan_nvidia_args` and `set_nvidia_type` into new `set_nvidia_query` * Added a translation array for `nvidia`, `nvidiabar`, `nvidiagauge` and `nvidiagraph` commands (helps with error printing) * Added some NORM_ERR prints to `get_nvidia_barval`, `get_nvidia_value` and `get_nvidia_string` * Removed exess newlines in nvidia's core.cc error definitions Signed-off-by: Matt Sturgeon <matt@sturgeon.me.uk> * nvidia: Better sanity checks when running queries Introduced a pair of functions that checks whether the target we are querying exists and how many of the target there are. If the target doesn't exist there probably isn't a nvidia card installed, if the target count query fails then the propietary drivers probably aren't installed. Fixes #269 Signed-off-by: Matt Sturgeon <matt@sturgeon.me.uk> |
||
|---|---|---|
| .. | ||
| CMakeLists.txt | ||
| command_options.xml | ||
| config_settings.xml | ||
| config_settings.xsl | ||
| conky-howto.xml | ||
| docgen.sh | ||
| docs.xml | ||
| lua.xml | ||
| lua.xsl | ||
| README.docs | ||
| variables.xml | ||
| variables.xsl | ||
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