1
0
mirror of https://github.com/Llewellynvdm/conky.git synced 2024-12-25 04:06:03 +00:00
conky/doc
Brenden Matthews 801cf11545 * Added patch for the following (thanks larsko):
* New $loadgraph to show a graph of load averages,
* add "show_graph_scale" option to turn off/on the showing of the
current max value for the graph,
* minor code fixes,
* update nano and vim syntax highlighting stuff.

git-svn-id: https://conky.svn.sourceforge.net/svnroot/conky/trunk/conky1@1104 7f574dfc-610e-0410-a909-a81674777703
2008-04-13 04:10:35 +00:00
..
command_options.xml bump version; doc fixes 2008-04-01 04:59:00 +00:00
config_settings.xml * Added patch for the following (thanks larsko): 2008-04-13 04:10:35 +00:00
config_settings.xsl Reformatted all code 2008-02-20 20:30:45 +00:00
conky-howto.xml Updated docs to include RSS and wireless. README has not been built. 2007-08-07 22:42:30 +00:00
conky.1 * Added patch for the following (thanks larsko): 2008-04-13 04:10:35 +00:00
conky.conf * Added patch for the following (thanks larsko): 2008-04-13 04:10:35 +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 docs 2008-04-01 21:37:49 +00:00
Makefile.am added $execpi, new ebuild, various other misc updates 2008-03-22 06:10:54 +00:00
README.docs Reformatted all code 2008-02-20 20:30:45 +00:00
variables.xml * Added patch for the following (thanks larsko): 2008-04-13 04:10:35 +00:00
variables.xsl Reformatted all code 2008-02-20 20:30:45 +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