1
0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-12-25 12:10:03 +00:00
conky/doc
Philip Kovacs 94ce348f97 update sample conkyrc
git-svn-id: https://conky.svn.sourceforge.net/svnroot/conky/trunk/conky1@807 7f574dfc-610e-0410-a909-a81674777703
2006-12-09 18:18:13 +00:00
..
command_options.xml fixed up some stuff in the docs 2005-08-30 02:45:09 +00:00
config_settings.xml use GLib GHashTable for port monitors 2006-12-09 05:40:08 +00:00
config_settings.xsl fixed typos, changed the look of the pretty html tables (thanks cptn for xsl advice), and these tables are now generated as part of the Makefile process too (only requires xsltproc, which we check for already). 2005-08-27 21:04:37 +00:00
conky-howto.xml gentoo howto, small fix 2006-02-25 03:13:27 +00:00
conky.1 use GLib GHashTable for port monitors 2006-12-09 05:40:08 +00:00
conkyrc.sample update sample conkyrc 2006-12-09 18:18:13 +00:00
docgen.sh changed docgen.sh to no longer do gzipping, also replaces first line with something more manpage compatible 2005-08-24 20:42:15 +00:00
docs.xml removed all mldonkey and seti code -- totally broken 2006-11-05 00:23:18 +00:00
Makefile.am removing docbook thing 2005-11-17 00:30:11 +00:00
README.docs docs 2005-08-22 17:08:55 +00:00
variables.xml add max_length to audacious_title 2006-12-01 00:29:12 +00:00
variables.xsl fixed typos, changed the look of the pretty html tables (thanks cptn for xsl advice), and these tables are now generated as part of the Makefile process too (only requires xsltproc, which we check for already). 2005-08-27 21:04:37 +00:00

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